<!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Joe</firstname>">
  <!ENTITY dhsurname   "<surname>Drew</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>July 15, 2001</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>drew@debian.org</email>">
  <!ENTITY dhusername  "Joe Drew">
  <!ENTITY dhucpackage "<refentrytitle>MPG321</refentrytitle>">
  <!ENTITY dhpackage   "mpg321">

  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <docinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2001</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </docinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>Free clone of mpg123, a command-line mp3 player</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage; [options] file(s) | URL(s) | -</command>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&dhpackage;</command> is a free command-line mp3 player,
    which uses the mad audio decoding library. &dhpackage; is written to be a 
    drop-in replacement for the non-free <command>mpg123</command> player.
    Some functions remain unimplemented, but &dhpackage; should function as a
    basic drop-in replacement for <command>mpg123</command> front-ends such as 
    <command>gqmpeg</command>, and those programs which use mpg123 to decode
    mp3 files (like <command>gtoaster</command>, and other CD-recording 
    software).</para>
    
    <para><command>&dhpackage;</command> differs from <command>mpg123</command>
    in several ways. First and foremost, it is fully Free, under the GNU General
    Public License. Secondly, it allows run-time switching of output devices
    (via the -o switch). (<command>&dhpackage;</command> also allows configuring
    a default output device at compile-time, but run-time switching is always
    allowed). </para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-o devicetype</option>
        </term>
        <listitem>
          <para>Set the output device type to <option>devicetype</option>. 
              <option>devicetype</option> can be one of:</para>
              <para>oss - the Linux Open Sound System;</para>
              <para>sun - the Sun audio system;</para>
              <para>alsa - the Advanced Linux Sound Architecture;</para>
	      <para>alsa09 - the Advanced Linux Sound Architecture, version 0.9;</para>
              <para>esd - the Enlightened Sound Daemon;</para>
              <para>arts - the analog real-time synthesiser </para>
          <para>See <option>-a device</option>, below.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-a device</option>, <option>--audiodevice device</option></term>
        <listitem>
          <para>Use <option>device</option> for audio-out instead of the default device, 
                depending on the output device you've chosen (via <option>-o devicetype</option>).
                By default this is the native sound device.
                Generally this is the device for <option>devicetype</option> 
                (or the default system device) to use for output (i.e. <filename>/dev/sound/dsp1</filename>).
          </para>
          <para>This option has no effect with <option>-o arts</option>.</para>
          <para>For <option>-o esd</option>, specify the host on which esd is running; defaults to localhost. </para>
          <para>For <option>-o alsa</option>, specify card:device; defaults to 0:0.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-g N</option>, <option>--gain N</option>
        </term>
        <listitem>
          <para>Set gain (volume) to N (1-100).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-k N</option>, <option>--skip N</option>
        </term>
        <listitem>
          <para>Skip N frames into the file being played.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n N</option>, <option>--frames N</option>
        </term>
        <listitem>
          <para>Decode only the first N frames of the stream. By default, the entire stream is decoded.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-@ list</option>, <option>--list list</option>
        </term>
        <listitem>
          <para>Use the file list for a playlist. The list should be in a format of filenames followed by a line feed. Multiple -@ or --list specifiers will be ignored; only the last -@ or --list option will be used. The playlist is concatenated with filenames specified on the command-line to produce one master playlist. A filename of '-' will cause standard input to be read as a playlist.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-z</option>, <option>--shuffle</option></term>
	<listitem><para>Shuffle playlists and files specified on the command-line. Produces a randomly-sorted playlist which is then played through once.</para></listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-Z</option>, <option>--random</option></term>
	<listitem><para>Randomise playlists and files specified on the command-line. Files are played through, choosing at random; this means that random files will be played for as long as mpg321 is running.</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>, <option>--verbose</option>
        </term>
        <listitem>
          <para>Be more verbose. Show current byte, bytes remaining, time, and time remaining, as well as more information about the mp3 file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>, <option>--stdout</option>
        </term>
        <listitem>
          <para>Use standard output instead of an audio device for output. Output is in 16-bit PCM, little-endian.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-w N</option>, <option>--wav N</option>
        </term>
        <listitem><para>Write to wav file N instead of using the audio device. This option will be preferred if --cdr or --au are specified too. Specifying '-' for N will cause the file to be written to standard output.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--cdr N</option>
        </term>
        <listitem><para>Write to cdr file N instead of using the audio device. Specifying '-' for N will cause the file to be written to standard output.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--au N</option>
        </term>
        <listitem><para>Write to au file N instead of using the audio device. Specifying '-' for N will cause the file to be written to standard output.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option>, <option>--test</option>
        </term>
        <listitem>
          <para>Test mode; do no output at all.
          </para>
        </listitem>
      </varlistentry> 
      <varlistentry>
        <term><option>-q</option>, <option>--quiet</option>
        </term>
        <listitem>
          <para>Quiet mode; suppress output of mpg123 boilerplate and file and song name.
          </para>
        </listitem>
      </varlistentry> 
      <varlistentry>
        <term><option>-R</option>
        </term>
        <listitem>
          <para>"Remote control" mode. Useful for front-ends. Allows seeking and pausing of mp3 files. See README.remote (in /usr/share/doc/mpg321 on Debian and some other systems.)
          </para>
        </listitem>
      </varlistentry> 
      <varlistentry>
        <term><option>--stereo</option>
        </term>
        <listitem>
          <para>Force stereo output: duplicates mono stream on second output channel. Useful for output for devices that don't understand mono, such as some CD players.
          </para>
        </listitem>
      </varlistentry> 
      <varlistentry>
        <term><option>--aggressive</option>
        </term>
        <listitem>
          <para>Aggressive mode; try to get higher priority on the system. Needs root permissions.
          </para>
        </listitem>
      </varlistentry> 
      <varlistentry>
        <term><option>--skip-printing-frames=N</option>
        </term>
        <listitem>
          <para>Skip N frames between printing a frame status update, in both Remote Control (-R) and verbose (-v) mode. Can help CPU utilisation on slower machines. This is an mpg321-specific option.
          </para>
        </listitem>
      </varlistentry> 
      <varlistentry>
        <term><option>--help</option>, <option>--longhelp</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-V</option>, <option>--version</option>
        </term>
        <listitem>
          <para>Show version of program.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1> 
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &lt;&dhemail;&gt;.</para> 

     <para>Permission is granted to copy, distribute and/or modify
      this document under the terms of the <acronym>BSD</acronym> license.
      On Debian systems, this can be found in 
      <filename>/usr/share/common-licenses/BSD</filename>.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
