source: multimedia/audioutils/vorbistools.xml@ 89464ed

<!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 vorbistools-download-http "http://www.vorbis.com/files/1.0.1/unix/vorbis-tools-&vorbistools-version;.tar.gz">
  <!ENTITY vorbistools-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/vorbis-tools-&vorbistools-version;.tar.gz">
  <!ENTITY vorbistools-md5sum        "80d3ae3bbae2a488d433d86b8fd64777">
  <!ENTITY vorbistools-size          "701 KB">
  <!ENTITY vorbistools-buildsize     "5.3 MB">
  <!ENTITY vorbistools-time          "0.12 SBU">
]>

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

<sect2>
<title>Introduction to <application>Vorbis Tools</application></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 <acronym>CODEC</acronym>.</para>

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

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

<sect4><title>Recommended (required to build the <command>ogg123</command> 
program)</title>
<para><xref linkend="curl"/> and <xref linkend="libao"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="flac"/> and <xref linkend="speex"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Vorbis Tools</application></title>

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

<screen><userinput><command>./configure --prefix=/usr &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>Configuring <application>Vorbis Tools</application></title>

<sect3 id="vorbistools-config"><title>Config files</title>
<para><filename>/etc/libao.conf</filename>, 
<filename>~/.libao</filename>, 
<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.0.1/ogg123rc-example</filename>.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>ogg123, oggdec, oggenc, ogginfo, vcut and vorbiscomment</seg>
<seg>/usr/share/doc/vorbis-tools-&vorbistools-version;</seg>
</seglistitem>
</segmentedlist>

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

<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 
<acronym>PCM</acronym> audio files (<acronym>WAV</acronym> 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, <acronym>WAV</acronym> or 
<acronym>AIFF</acronym> 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>