source: archive/esound.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 9.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 esound-download-http "&gnome-download-http;/esound/0.2/esound-&esound-version;.tar.bz2">
8 <!ENTITY esound-download-ftp "&gnome-download-ftp;/esound/0.2/esound-&esound-version;.tar.bz2">
9 <!ENTITY esound-md5sum "8d9aad3d94d15e0d59ba9dc0ea990c6c">
10 <!ENTITY esound-size "392 KB">
11 <!ENTITY esound-buildsize "5.3 MB">
12 <!ENTITY esound-time "0.3 SBU">
13]>
14
15<sect1 id="esound" xreflabel="EsounD-&esound-version;">
16 <?dbhtml filename="esound.html"?>
17
18
19 <title>EsounD-&esound-version;</title>
20
21 <indexterm zone="esound">
22 <primary sortas="a-EsounD">EsounD</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to EsounD</title>
27
28 <para>The <application>EsounD</application> package contains
29 the Enlightened Sound Daemon. This is useful for mixing together
30 several digitized audio streams for playback by a single device.</para>
31
32 &lfs74_checked;
33
34 <bridgehead renderas="sect3">Package Information</bridgehead>
35 <itemizedlist spacing="compact">
36 <listitem>
37 <para>Download (HTTP): <ulink url="&esound-download-http;"/></para>
38 </listitem>
39 <listitem>
40 <para>Download (FTP): <ulink url="&esound-download-ftp;"/></para>
41 </listitem>
42 <listitem>
43 <para>Download MD5 sum: &esound-md5sum;</para>
44 </listitem>
45 <listitem>
46 <para>Download size: &esound-size;</para>
47 </listitem>
48 <listitem>
49 <para>Estimated disk space required: &esound-buildsize;</para>
50 </listitem>
51 <listitem>
52 <para>Estimated build time: &esound-time;</para>
53 </listitem>
54 </itemizedlist>
55
56 <bridgehead renderas="sect3">EsounD Dependencies</bridgehead>
57
58 <bridgehead renderas="sect4">Required</bridgehead>
59 <para role="required"><xref linkend="audiofile"/></para>
60
61 <bridgehead renderas="sect4">Optional</bridgehead>
62 <para role="optional"><xref linkend="alsa-lib"/> and
63 <xref linkend="docbook-utils"/> (Required for building the html documentation)</para>
64
65 <para condition="html" role="usernotes">User Notes:
66 <ulink url="&blfs-wiki;/esound"/></para>
67
68 </sect2>
69
70 <sect2 role="installation">
71 <title>Installation of EsounD</title>
72
73 <para>Install <application>EsounD</application> by running the following
74 commands:</para>
75
76<screen><userinput>LIBS=-lm ./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
77make</userinput></screen>
78
79 <para>This package does not come with a test suite.</para>
80
81 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
82
83<screen role="root"><userinput>make install docdir=/usr/share/doc/esound-&esound-version;</userinput></screen>
84
85 <para>If you have <application>DocBook-utils</application> installed, still
86 as the <systemitem class="username">root</systemitem> user:</para>
87
88<screen role="root"><userinput>chown -v root:root /usr/share/doc/esound-&esound-version;/*</userinput></screen>
89
90 </sect2>
91
92 <sect2 role="commands">
93 <title>Command Explanations</title>
94
95 <para><parameter>LIBS=-lm</parameter>: Make sure the linker uses the math
96 library.</para>
97
98 <para><parameter>--sysconfdir=/etc</parameter>: This switch puts
99 configuration files in <filename class="directory">/etc</filename> instead
100 of <filename class="directory">/usr/etc</filename>.</para>
101
102 <para><parameter>--disable-static</parameter>: Prevent the static libraries
103 being built.</para>
104
105 </sect2>
106
107 <sect2 role="configuration">
108 <title>Configuring EsounD</title>
109
110 <sect3 id="esound-config">
111 <title>Config Files</title>
112
113 <para><filename>/etc/esd.conf</filename></para>
114
115 <indexterm zone="esound esound-config">
116 <primary sortas="e-etc-esd.conf">/etc/esd.conf</primary>
117 </indexterm>
118
119 </sect3>
120
121 <sect3>
122 <title>Configuration Information</title>
123
124 <para>Instructions and information about the configuration file is
125 located in the <filename>TIPS</filename> file in the
126 <application>EsounD</application> source directory.</para>
127
128 </sect3>
129
130 </sect2>
131
132 <sect2 role="content">
133 <title>Contents</title>
134
135 <segmentedlist>
136 <segtitle>Installed Programs</segtitle>
137 <segtitle>Installed Libraries</segtitle>
138 <segtitle>Installed Directory</segtitle>
139
140 <seglistitem>
141 <seg>esd, esdcat, esd-config, esdctl, esddsp, esdfilt, esdloop, esdmon,
142 esdplay, esdrec, and esdsample</seg>
143 <seg>libesd.{so,a} and libesddsp.{so,a}</seg>
144 <seg>/usr/share/doc/esound</seg>
145 </seglistitem>
146 </segmentedlist>
147
148 <variablelist>
149 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
150 <?dbfo list-presentation="list"?>
151 <?dbhtml list-presentation="table"?>
152
153 <varlistentry id="esd">
154 <term><command>esd</command></term>
155 <listitem>
156 <para>is the Enlightened Sound Daemon.</para>
157 <indexterm zone="esound esd">
158 <primary sortas="b-esd">esd</primary>
159 </indexterm>
160 </listitem>
161 </varlistentry>
162
163 <varlistentry id="esdcat">
164 <term><command>esdcat</command></term>
165 <listitem>
166 <para>plays a RAW audio stream through the daemon.</para>
167 <indexterm zone="esound esdcat">
168 <primary sortas="b-esdcat">esdcat</primary>
169 </indexterm>
170 </listitem>
171 </varlistentry>
172
173 <varlistentry id="esd-config">
174 <term><command>esd-config</command></term>
175 <listitem>
176 <para>is used by <command>configure</command> to determine the
177 compiler and linker flags that should be used to compile and link programs
178 that use <application>EsounD</application>.</para>
179 <indexterm zone="esound esd-config">
180 <primary sortas="b-esd-config">esd-config</primary>
181 </indexterm>
182 </listitem>
183 </varlistentry>
184
185 <varlistentry id="esdctl">
186 <term><command>esdctl</command></term>
187 <listitem>
188 <para> controls certain aspects of the sound daemon.</para>
189 <indexterm zone="esound esdctl">
190 <primary sortas="b-esdctl">esdctl</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="esddsp">
196 <term><command>esddsp</command></term>
197 <listitem>
198 <para>can allow non-esd applications to be routed through esd.</para>
199 <indexterm zone="esound esddsp">
200 <primary sortas="b-esddsp">esddsp</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="esdfilt">
206 <term><command>esdfilt</command></term>
207 <listitem>
208 <para>is an <application>EsoundD</application> filter.</para>
209 <indexterm zone="esound esdfilt">
210 <primary sortas="b-esdfilt">esdfilt</primary>
211 </indexterm>
212 </listitem>
213 </varlistentry>
214
215 <varlistentry id="esdloop">
216 <term><command>esdloop</command></term>
217 <listitem>
218 <para>is test scaffolding for sample cache, loop and free.</para>
219 <indexterm zone="esound esdloop">
220 <primary sortas="b-esdloop">esdloop</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="esdmon">
226 <term><command>esdmon</command></term>
227 <listitem>
228 <para>outputs the mixed stream from the daemon.</para>
229 <indexterm zone="esound esdmon">
230 <primary sortas="b-esdmon">esdmon</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="esdplay">
236 <term><command>esdplay</command></term>
237 <listitem>
238 <para>plays the named file on
239 <application>EsoundD</application>.</para>
240 <indexterm zone="esound esdplay">
241 <primary sortas="b-esdplay">esdplay</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="esdrec">
247 <term><command>esdrec</command></term>
248 <listitem>
249 <para>outputs from the sound device's current input.</para>
250 <indexterm zone="esound esdrec">
251 <primary sortas="b-esdrec">esdrec</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="esdsample">
257 <term><command>esdsample</command></term>
258 <listitem>
259 <para>is test scaffolding for sample cache, playback, and free.</para>
260 <indexterm zone="esound esdsample">
261 <primary sortas="b-esdsample">esdsample</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="libesd">
267 <term><filename class='libraryfile'>libesd.{so,a}</filename></term>
268 <listitem>
269 <para>contains functions used by the <application>EsounD</application>
270 programs to read, write and play various sound format files.</para>
271 <indexterm zone="esound libesd">
272 <primary sortas="c-libesd">libesd.{so,a}</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="libesddsp">
278 <term><filename class='libraryfile'>libesddsp.{so,a}</filename></term>
279 <listitem>
280 <para>contains functions used by other programs to read, write and
281 play various sound format files.</para>
282 <indexterm zone="esound libesddsp">
283 <primary sortas="c-libesddsp">libesddsp.{so,a}</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 </variablelist>
289
290 </sect2>
291
292</sect1>
Note: See TracBrowser for help on using the repository browser.