source: multimedia/audioutils/vorbistools.xml@ 9f80536

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

<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 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>Optional</title>
<para><xref linkend="curl"/>, 
<xref linkend="libao"/>,
<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 &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Configuring <application>Vorbis Tools</application></title>

<sect3><title>Config files</title>
<para><filename>/etc/libao.conf</filename>, 
<filename>~/.libao</filename>, 
<filename>~/.ogg123rc</filename></para>
</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>

<para>The <application>Vorbis Tools</application> package contains 
<command>ogg123</command> (requires <xref linkend="curl"/>), 
<command>oggdec</command>, 
<command>oggenc</command>, 
<command>ogginfo</command>, 
<command>vcut</command> and 
<command>vorbiscomment</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>ogg123</title>
<para><command>ogg123</command> is a command-line audio player for Ogg Vorbis 
streams.</para></sect3>

<sect3><title>oggdec</title>
<para><command>oggdec</command> is a simple decoder which converts Ogg Vorbis 
files into <acronym>PCM</acronym> audio files (<acronym>WAV</acronym> or
raw).</para></sect3>

<sect3><title>oggenc</title>
<para><command>oggenc</command> is the encoder that turns raw,
<acronym>WAV</acronym> or <acronym>AIFF</acronym> files into an Ogg
Vorbis stream.</para></sect3>

<sect3><title>ogginfo</title>
<para><command>ogginfo</command> prints information stored in the audio
file.</para></sect3>

<sect3><title>vcut</title>
<para><command>vcut</command> will split a file into two files at a designated 
cut point.</para></sect3>

<sect3><title>vorbiscomment</title>
<para><command>vorbiscomment</command> is an editor that changes information in 
the audio file metadata tags.</para></sect3>

</sect2>

</sect1>