source: multimedia/audioutils/mpg123.xml

trunk
Last change on this file was 1241ea19, checked in by Bruce Dubbs <bdubbs@…>, 9 days ago

Tag xfce and dependencies

  • Property mode set to 100644
File size: 6.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY mpg123-download-http "&sourceforge-dl;/mpg123/mpg123-&mpg123-version;.tar.bz2">
8 <!ENTITY mpg123-download-ftp " ">
9 <!ENTITY mpg123-md5sum "6155361044162c2454f586a128bf5137">
10 <!ENTITY mpg123-size "1.1 MB">
11 <!ENTITY mpg123-buildsize "17 MB (with tests)">
12 <!ENTITY mpg123-time "0.2 SBU (with tests)">
13]>
14
15<sect1 id="mpg123" xreflabel="mpg123-&mpg123-version;">
16 <?dbhtml filename="mpg123.html"?>
17
18
19 <title>mpg123-&mpg123-version;</title>
20
21 <indexterm zone="mpg123">
22 <primary sortas="a-mpg123">mpg123</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to mpg123</title>
27
28 <para>
29 The <application>mpg123</application> package contains a console-based MP3
30 player. It claims to be the fastest MP3 decoder for Unix.
31 </para>
32
33 &lfs121_checked;
34
35 <bridgehead renderas="sect3">Package Information</bridgehead>
36 <itemizedlist spacing="compact">
37 <listitem>
38 <para>
39 Download (HTTP): <ulink url="&mpg123-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&mpg123-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &mpg123-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &mpg123-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &mpg123-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &mpg123-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3">mpg123 Dependencies</bridgehead>
70
71 <bridgehead renderas="sect4">Recommended</bridgehead>
72 <para role="recommended">
73 <xref linkend="alsa-lib"/>
74 </para>
75
76 <bridgehead renderas="sect4">Optional</bridgehead>
77 <para role="optional">
78 <xref linkend="pulseaudio"/>,
79 <xref linkend="sdl"/>,
80 <ulink url="https://jackaudio.org">JACK</ulink>,
81 <ulink url="https://openal.org/">OpenAL</ulink> and
82 <ulink url="http://www.portaudio.com/">PortAudio</ulink>
83 </para>
84
85 </sect2>
86
87 <sect2 role="installation">
88 <title>Installation of mpg123</title>
89
90 <para>
91 Install <application>mpg123</application> by running the following
92 commands:
93 </para>
94
95<screen><userinput>./configure --prefix=/usr &amp;&amp;
96make</userinput></screen>
97
98 <para>
99 To test the results, issue: <command>make check</command>.
100 </para>
101
102 <para>
103 Now, as the <systemitem class="username">root</systemitem> user:
104 </para>
105
106<screen role="root"><userinput>make install</userinput></screen>
107
108 </sect2>
109<!--
110 <sect2 role="commands">
111 <title>Command Explanations</title>
112
113 <para>
114 <parameter>- -with-module-suffix=.so</parameter>: This switch tells
115 <command>mpg123</command> to load modules with
116 <filename class="extension">.so</filename> extension which is useful if you
117 don't want to keep <filename class="extension">.la</filename> files.
118 </para>
119
120 </sect2>
121-->
122 <sect2 role="content">
123 <title>Contents</title>
124
125 <segmentedlist>
126 <segtitle>Installed Programs</segtitle>
127 <segtitle>Installed Libraries</segtitle>
128 <segtitle>Installed Directory</segtitle>
129
130 <seglistitem>
131 <seg>
132 mpg123, mpg123-id3dump, mpg123-strip, and out123
133 </seg>
134 <seg>
135 libmpg123.so, libout123.so, and libsyn123.so
136 </seg>
137 <seg>
138 /usr/lib/mpg123
139 </seg>
140 </seglistitem>
141 </segmentedlist>
142
143 <variablelist>
144 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
145 <?dbfo list-presentation="list"?>
146 <?dbhtml list-presentation="table"?>
147
148 <varlistentry id="mpg123-prog">
149 <term><command>mpg123</command></term>
150 <listitem>
151 <para>
152 is used for playing MP3 files via the console
153 </para>
154 <indexterm zone="mpg123 mpg123-prog">
155 <primary sortas="b-mpg123">mpg123</primary>
156 </indexterm>
157 </listitem>
158 </varlistentry>
159
160 <varlistentry id="mpg123-id3dump">
161 <term><command>mpg123-id3dump</command></term>
162 <listitem>
163 <para>
164 is a tool to dump ID3 meta data from MPEG audio files
165 using libmpg123
166 </para>
167 <indexterm zone="mpg123 mpg123-id3dump">
168 <primary sortas="b-mpg123">mpg123-id3dump</primary>
169 </indexterm>
170 </listitem>
171 </varlistentry>
172
173 <varlistentry id="mpg123-strip">
174 <term><command>mpg123-strip</command></term>
175 <listitem>
176 <para>
177 extracts only MPEG frames from a stream using libmpg123
178 (stdin to stdout)
179 </para>
180 <indexterm zone="mpg123 mpg123-strip">
181 <primary sortas="b-mpg123">mpg123-strip</primary>
182 </indexterm>
183 </listitem>
184 </varlistentry>
185
186 <varlistentry id="out123">
187 <term><command>out123</command></term>
188 <listitem>
189 <para>
190 plays raw PCM audio to an output device
191 </para>
192 <indexterm zone="mpg123 out123">
193 <primary sortas="b-mpg123">out123</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="libmpg123">
199 <term><filename class="libraryfile">libmpg123.so</filename></term>
200 <listitem>
201 <para>
202 contains the <application>mpg123</application> API functions
203 </para>
204 <indexterm zone="mpg123 libmpg123">
205 <primary sortas="c-libmpg123">libmpg123.so</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="libout123">
211 <term><filename class="libraryfile">libout123.so</filename></term>
212 <listitem>
213 <para>
214 contains the <application>out123</application> API functions
215 </para>
216 <indexterm zone="mpg123 libout123">
217 <primary sortas="c-libout123">libout123.so</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="libsyn123">
223 <term><filename class="libraryfile">libsyn123.so</filename></term>
224 <listitem>
225 <para>
226 contains some audio signal synthesis and format conversion
227 functions
228 </para>
229 <indexterm zone="mpg123 libsyn123">
230 <primary sortas="c-libsyn123">libsyn123.so</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 </variablelist>
236
237 </sect2>
238
239</sect1>
Note: See TracBrowser for help on using the repository browser.