source: multimedia/audioutils/mpg123.xml@ 6666fad

<?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 mpg123-download-http "&sourceforge-dl;/mpg123/mpg123-&mpg123-version;.tar.bz2">
  <!ENTITY mpg123-download-ftp  " ">
  <!ENTITY mpg123-md5sum        "64749512a6fdc117227abe13fee4cc36">
  <!ENTITY mpg123-size          "892 KB">
  <!ENTITY mpg123-buildsize     "13 MB">
  <!ENTITY mpg123-time          "0.2 SBU">
]>

<sect1 id="mpg123" xreflabel="mpg123-&mpg123-version;">
  <?dbhtml filename="mpg123.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>mpg123-&mpg123-version;</title>

  <indexterm zone="mpg123">
    <primary sortas="a-mpg123">mpg123</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to mpg123</title>

    <para>
      The <application>mpg123</application> package contains a console-based MP3
      player. It claims to be the fastest MP3 decoder for Unix.
    </para>

    &lfs84_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&mpg123-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&mpg123-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &mpg123-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &mpg123-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &mpg123-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &mpg123-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">mpg123 Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="alsa-lib"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="pulseaudio"/>,
      <xref linkend="sdl"/>,
      <ulink url="http://jackaudio.org">JACK</ulink>,
      <ulink url="http://kcat.strangesoft.net/openal-releases/">OpenAL</ulink> and
      <ulink url="http://www.portaudio.com">PortAudio</ulink>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/mpg123"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of mpg123</title>

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

<screen><userinput>./configure --prefix=/usr &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>
      <parameter>- -with-module-suffix=.so</parameter>: This switch tells
      <command>mpg123</command> to load modules with
      <filename class="extension">.so</filename> extension which is useful if you
      don't want to keep <filename class="extension">.la</filename> files.
    </para>

  </sect2>
-->
  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          mpg123, mpg123-id3dump, mpg123-strip, and out123
        </seg>
        <seg>
          libmpg123.so and libout123.so
        </seg>
        <seg>
          /usr/lib/mpg123
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="mpg123-prog">
        <term><command>mpg123</command></term>
        <listitem>
          <para>
            is used for playing MP3 files via the console.
          </para>
          <indexterm zone="mpg123 mpg123-prog">
            <primary sortas="b-mpg123">mpg123</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mpg123-id3dump">
        <term><command>mpg123-id3dump</command></term>
        <listitem>
          <para>
            is a tool to dump ID3 meta data from MPEG audio files 
            using libmpg123
          </para>
          <indexterm zone="mpg123 mpg123-id3dump">
            <primary sortas="b-mpg123">mpg123-id3dump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mpg123-strip">
        <term><command>mpg123-strip</command></term>
        <listitem>
          <para>
            extracts only MPEG frames from a stream using libmpg123 
            (stdin to stdout)
          </para>
          <indexterm zone="mpg123 mpg123-strip">
            <primary sortas="b-mpg123">mpg123-strip</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="out123">
        <term><command>out123</command></term>
        <listitem>
          <para>
            plays raw PCM audio to an output device
          </para>
          <indexterm zone="mpg123 out123">
            <primary sortas="b-mpg123">out123</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmpg123">
        <term><filename class="libraryfile">libmpg123.so</filename></term>
        <listitem>
          <para>
            contains the <application>mpg123</application> API functions.
          </para>
          <indexterm zone="mpg123 libmpg123">
            <primary sortas="c-libmpg123">libmpg123.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libout123">
        <term><filename class="libraryfile">libout123.so</filename></term>
        <listitem>
          <para>
            contains the <application>out123</application> API functions.
          </para>
          <indexterm zone="mpg123 libout123">
            <primary sortas="c-libout123">libout123.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>