File: mpg321.sgml

package info (click to toggle)
mpg321 0.2.10.6
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 696 kB
  • ctags: 201
  • sloc: ansic: 3,152; sh: 807; makefile: 79
file content (264 lines) | stat: -rw-r--r-- 10,573 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<!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:
-->