source: multimedia/libdriv/alsa-lib.xml

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

Tag xfce and dependencies
  • Property mode set to 100644
File size: 8.4 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 alsa-lib-download-http "&alsa-download-http;/lib/alsa-lib-&alsa-lib-version;.tar.bz2">
8 <!ENTITY alsa-lib-download-ftp " ">
9 <!ENTITY alsa-lib-md5sum "1c5870770047b6a520d18a43f49e42ea">
10 <!ENTITY alsa-lib-size "1.1 MB">
11 <!ENTITY alsa-lib-buildsize "46 MB (with tests and docs)">
12 <!ENTITY alsa-lib-time "0.3 SBU (with tests and docs)">
13]>
14
15<sect1 id="alsa-lib" xreflabel="alsa-lib-&alsa-lib-version;">
16 <?dbhtml filename="alsa-lib.html"?>
17
18
19 <title>alsa-lib-&alsa-lib-version;</title>
20
21 <indexterm zone="alsa-lib">
22 <primary sortas="a-alsa-lib">alsa-lib</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to ALSA Library</title>
27
28 <para>
29 The <application>ALSA Library</application> package contains
30 the ALSA library used by programs (including <application>ALSA
31 Utilities</application>) requiring access to the ALSA sound
32 interface.
33 </para>
34
35 &lfs121_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&alsa-lib-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&alsa-lib-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &alsa-lib-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &alsa-lib-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &alsa-lib-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &alsa-lib-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70<!--
71 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
72 <itemizedlist spacing="compact">
73 <listitem>
74 <para>
75 Required patch:
76 <ulink url="&patch-root;/alsa-lib-&alsa-lib-version;-upstream_fixes-1.patch"/>
77 </para>
78 </listitem>
79 </itemizedlist>
80-->
81 <bridgehead renderas="sect3">ALSA Library Dependencies</bridgehead>
82
83 <bridgehead renderas="sect4">Recommended (Runtime)</bridgehead>
84 <para role="runtime">
85 <phrase revision='sysv'><xref linkend='elogind'/></phrase>
86 <phrase revision='systemd'><xref linkend='systemd'/></phrase>
87 </para>
88
89 <note>
90 <para>
91 If the recommended runtime dependency is not installed, you may
92 need to run any application requiring ALSA library as the &root;
93 user or a user in the
94 <systemitem class='groupname'>audio</systemitem> group.
95 </para>
96 </note>
97
98 <bridgehead renderas="sect4">Optional</bridgehead>
99 <para role="optional">
100 <xref linkend="doxygen"/>,
101 <xref linkend="python2"/>, and
102 <ulink url="https://www.alsa-project.org/files/pub/lib/alsa-ucm-conf-&alsa-lib-version;.tar.bz2">alsa-ucm-conf</ulink>
103 </para>
104
105 </sect2>
106
107 <sect2 role="kernel" id="alsa-lib-kernel">
108 <title>Kernel Configuration</title>
109
110 <para>
111 If needed, enable the following options in the kernel
112 configuration and recompile the kernel:
113 </para>
114
115 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
116 href="alsa-lib-kernel.xml"/>
117
118 <para>
119 In the Device Drivers &rArr; Sound card support &rArr; Advanced Linux
120 Sound Architecture section of the kernel configuration, select the
121 settings and drivers appropriate for your hardware. If necessary,
122 recompile and install your new kernel.
123 </para>
124
125 <indexterm zone="alsa-lib alsa-lib-kernel">
126 <primary sortas="d-ALSA">ALSA</primary>
127 </indexterm>
128
129 </sect2>
130
131 <sect2 role="installation">
132 <title>Installation of ALSA Library</title>
133<!--
134 <para>
135 First, if you are building on a 32-bit system, fix a regression that
136 causes a segmentation fault when playing audio:
137 </para>
138
139<screen><userinput>case $(uname -m) in
140 i?86) patch -Np1 -i ../alsa-lib-&alsa-lib-version;-upstream_fixes-1.patch ;;
141esac</userinput></screen>
142-->
143 <para>
144 Install <application>ALSA Library</application> by
145 running the following commands:
146 </para>
147
148<screen><userinput>./configure &amp;&amp;
149make</userinput></screen>
150
151 <para>
152 If you have <application>Doxygen</application> installed and you wish to
153 build the library API documentation, run the following
154 commands from the top-level directory of the source tree:
155 </para>
156
157<screen remap="doc"><userinput>make doc</userinput></screen>
158
159 <para>
160 To test the results, issue: <command>make check</command>.
161 </para>
162
163 <para>
164 Now, as the <systemitem class="username">root</systemitem> user:
165 </para>
166
167<screen role="root"><userinput>make install</userinput></screen>
168
169 <para>
170 To install the API documentation, run the following command as
171 the <systemitem class="username">root</systemitem> user:
172 </para>
173
174<screen role="root"
175 remap="doc"><userinput>install -v -d -m755 /usr/share/doc/alsa-lib-&alsa-lib-version;/html/search &amp;&amp;
176install -v -m644 doc/doxygen/html/*.* \
177 /usr/share/doc/alsa-lib-&alsa-lib-version;/html &amp;&amp;
178install -v -m644 doc/doxygen/html/search/* \
179 /usr/share/doc/alsa-lib-&alsa-lib-version;/html/search</userinput></screen>
180
181 </sect2>
182
183 <sect2 role="configuration">
184 <title>Configuring ALSA Library</title>
185
186 <sect3 id="alsa-lib-config">
187 <title>Config Files</title>
188
189 <para>
190 <filename>~/.asoundrc</filename> and
191 <filename>/etc/asound.conf</filename>
192 </para>
193
194 <indexterm zone="alsa-lib alsa-lib-config">
195 <primary sortas="e-AA.asoundrc">~/.asoundrc</primary>
196 </indexterm>
197
198 <indexterm zone="alsa-lib alsa-lib-config">
199 <primary sortas="e-etc-asound.conf">/etc/asound.conf</primary>
200 </indexterm>
201
202 </sect3>
203
204 <sect3>
205 <title>Configuration Information</title>
206
207 <para>
208 The default <filename>alsa.conf</filename> is adequate for most
209 installations. For extra functionality and/or advanced control of your
210 sound device, you may need to create additional configuration files.
211 For information on the available configuration parameters, visit
212 <ulink url="https://www.alsa-project.org/main/index.php/Asoundrc"/>.
213 </para>
214
215 </sect3>
216
217 </sect2>
218
219 <sect2 role="content">
220 <title>Contents</title>
221
222 <segmentedlist>
223 <segtitle>Installed Program</segtitle>
224 <segtitle>Installed Library</segtitle>
225 <segtitle>Installed Directories</segtitle>
226
227 <seglistitem>
228 <seg>
229 aserver
230 </seg>
231 <seg>
232 libasound.so and
233 libatopology.so
234 </seg>
235 <seg>
236 /usr/include/alsa,
237 /usr/share/alsa and
238 /usr/share/doc/alsa-lib-&alsa-lib-version;
239 </seg>
240 </seglistitem>
241 </segmentedlist>
242
243 <variablelist>
244 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
245 <?dbfo list-presentation="list"?>
246 <?dbhtml list-presentation="table"?>
247
248 <varlistentry id="aserver">
249 <term><command>aserver</command></term>
250 <listitem>
251 <para>
252 is the ALSA server
253 </para>
254 <indexterm zone="alsa-lib aserver">
255 <primary sortas="b-aserver">aserver</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="libasound">
261 <term><filename class="libraryfile">libasound.so</filename></term>
262 <listitem>
263 <para>
264 contains the ALSA API functions
265 </para>
266 <indexterm zone="alsa-lib libasound">
267 <primary sortas="c-libasound">libasound.so</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="libatopology">
273 <term><filename class="libraryfile">libatopology.so</filename></term>
274 <listitem>
275 <para>
276 contains API functions for the ALSA topologies
277 </para>
278 <indexterm zone="alsa-lib libatopology">
279 <primary sortas="c-libatopology">libatopology.so</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 </variablelist>
285
286 </sect2>
287
288</sect1>
Note: See TracBrowser for help on using the repository browser.