glfs/multimedia/audioutils/vorbistools.xml
Randy McMurchy 410e228bb9 Removed extraneous whitespace from the ends of line text
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@7431 af4574ff-66df-0310-9fd7-8a98e5e911e0
2008-05-09 13:00:42 +00:00

265 lines
8.8 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 vorbistools-download-http "http://downloads.xiph.org/releases/vorbis/vorbis-tools-&vorbistools-version;.tar.gz">
<!ENTITY vorbistools-download-ftp " ">
<!ENTITY vorbistools-md5sum "df976d24e51ef3d87cd462edf747bf9a">
<!ENTITY vorbistools-size "1.0 MB">
<!ENTITY vorbistools-buildsize "7 MB">
<!ENTITY vorbistools-time "0.2 SBU">
]>
<sect1 id="vorbistools" xreflabel="Vorbis Tools-&vorbistools-version;">
<?dbhtml filename="vorbistools.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>Vorbis Tools-&vorbistools-version;</title>
<indexterm zone="vorbistools">
<primary sortas="a-Vorbis-Tools">Vorbis Tools</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Vorbis Tools</title>
<para>The <application>Vorbis Tools</application> package contains
command-line tools for Ogg audio files. This is useful for encoding,
playing or editing files using the Ogg CODEC.</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&vorbistools-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&vorbistools-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &vorbistools-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &vorbistools-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &vorbistools-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &vorbistools-time;</para>
</listitem>
</itemizedlist>
<!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing='compact'>
<listitem>
<para>Required Patch: <ulink
url="&patch-root;/vorbis-tools-&vorbistools-version;-utf8-1.patch"/></para>
</listitem>
<listitem>
<para>Required Patch: <ulink
url="&patch-root;/vorbis-tools-&vorbistools-version;-flac-1.patch"/></para>
</listitem>
</itemizedlist> -->
<bridgehead renderas="sect3">Vorbis Tools Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required"><xref linkend="libvorbis"/></para>
<bridgehead renderas="sect4">Optional (required to build the
<command>ogg123</command> program)</bridgehead>
<para role="optional"><xref linkend="libao"/></para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="curl"/>,
<xref linkend="flac"/>, and
<xref linkend="speex"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/vorbistools"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of Vorbis Tools</title>
<para>Install <application>Vorbis Tools</application> by running the
following commands:</para>
<screen><userinput>./configure --prefix=/usr \
--enable-vcut \
--without-curl &amp;&amp;
make</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</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<!-- <para><command>sed -i '/MUTE/d' ogg123/http_transport.c </command>: This
command fixes a build problem with new versions of
<application>cURL</application>.</para>
<para><command>patch -Np1 -i
../vorbis-tools-&vorbistools-version;-utf8-1.patch</command>: This patch
fixes a bug in <command>vorbiscomment</command> in UTF-8 locales.</para>
<para><command>patch -Np1 -i
../vorbis-tools-&vorbistools-version;-flac-1.patch</command>: This patch
allows <application>Vorbis-Tools</application> to link against new
versions of <application>FLAC</application>.</para>
<para><command>autoconf</command>: This command is used to regenerate the
<command>configure</command> script as the <application>FLAC</application>
patch modifies the <filename>configure.ac</filename> file.</para> -->
<para><parameter>--enable-vcut</parameter>: This parameter is used so that
the <command>vcut</command> program is built as it is not by
default.</para>
<!-- <para><parameter>-mandir=/usr/share/man</parameter>: This parameter
ensures that the man pages are installed under
<filename class="directory">/usr/share/man</filename>.</para> -->
<para><parameter>--without-curl</parameter>: This parameter disables HTTP
streaming in <command>ogg123</command>. Remove this parameter if you have
<application>cURL</application> installed.</para>
</sect2>
<sect2 role="configuration">
<title>Configuring Vorbis Tools</title>
<sect3 id="vorbistools-config">
<title>Config Files</title>
<para><filename>/etc/libao.conf</filename>,
<filename>~/.libao</filename>, and
<filename>~/.ogg123rc</filename></para>
<indexterm zone="vorbistools vorbistools-config">
<primary sortas="e-AA.libao">~/.libao</primary>
</indexterm>
<indexterm zone="vorbistools vorbistools-config">
<primary sortas="e-AA.ogg123rc">~/.ogg123rc</primary>
</indexterm>
<indexterm zone="vorbistools vorbistools-config">
<primary sortas="e-etc-libao.conf">/etc/libao.conf</primary>
</indexterm>
</sect3>
<sect3>
<title>Configuration Information</title>
<para>Issue <command>man libao.conf</command> for information
about setting the default output device. Also see
<filename>/usr/share/doc/vorbis-tools-1.1.1/ogg123rc-example</filename>.</para>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>ogg123, oggdec, oggenc, ogginfo, vcut, and vorbiscomment</seg>
<seg>None</seg>
<seg>/usr/share/doc/vorbis-tools-&vorbistools-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="ogg123">
<term><command>ogg123</command></term>
<listitem>
<para>is a command-line audio player for Ogg Vorbis streams.</para>
<indexterm zone="vorbistools ogg123">
<primary sortas="b-ogg123">ogg123</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="oggdec">
<term><command>oggdec</command></term>
<listitem>
<para>is a simple decoder which converts Ogg Vorbis files into
PCM audio files (WAV or raw).</para>
<indexterm zone="vorbistools oggdec">
<primary sortas="b-oggdec">oggdec</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="oggenc">
<term><command>oggenc</command></term>
<listitem>
<para>is an encoder that turns raw, WAV or
AIFF files into an Ogg Vorbis stream.</para>
<indexterm zone="vorbistools oggenc">
<primary sortas="b-oggenc">oggenc</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="ogginfo">
<term><command>ogginfo</command></term>
<listitem>
<para>prints information stored in an audio file.</para>
<indexterm zone="vorbistools ogginfo">
<primary sortas="b-ogginfo">ogginfo</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="vcut">
<term><command>vcut</command></term>
<listitem>
<para>will split a file into two files at a designated cut point.</para>
<indexterm zone="vorbistools vcut">
<primary sortas="b-vcut">vcut</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="vorbiscomment">
<term><command>vorbiscomment</command></term>
<listitem>
<para>is an editor that changes information in the audio file
metadata tags.</para>
<indexterm zone="vorbistools vorbiscomment">
<primary sortas="b-vorbiscomment">vorbiscomment</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>