source: multimedia/libdriv/alsa-lib.xml@ 2a72ab9

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 2a72ab9 was 2a72ab9, checked in by Ken Moffat <ken@…>, 9 months ago

Tags.

  • Property mode set to 100644
File size: 7.8 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 alsa-lib-download-http "&alsa-download-http;/lib/alsa-lib-&alsa-lib-version;.tar.bz2">
8 <!ENTITY alsa-lib-download-ftp "&alsa-download-ftp;/lib/alsa-lib-&alsa-lib-version;.tar.bz2">
9 <!ENTITY alsa-lib-md5sum "d29f5ebe9a4ff1be70508ecbf6655318">
10 <!ENTITY alsa-lib-size "1.1 MB">
11 <!ENTITY alsa-lib-buildsize "45 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 &lfs120_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">ALSA Library Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Recommended (Runtime)</bridgehead>
74 <para role="runtime">
75 <phrase revision='sysv'><xref linkend='elogind'/></phrase>
76 <phrase revision='systemd'><xref linkend='systemd'/></phrase>
77 </para>
78
79 <note>
80 <para>
81 If the recommended runtime dependency is not installed, you may
82 need to run any application requiring ALSA library as the &root;
83 user or a user in the
84 <systemitem class='groupname'>audio</systemitem> group.
85 </para>
86 </note>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
90 <xref linkend="doxygen"/>,
91 <xref linkend="python2"/>, and
92 <ulink url="https://www.alsa-project.org/files/pub/lib/">alsa-ucm-conf</ulink>
93 </para>
94
95 </sect2>
96
97 <sect2 role="kernel" id="alsa-lib-kernel">
98 <title>Kernel Configuration</title>
99
100 <para>
101 If needed, enable the following options in the kernel
102 configuration and recompile the kernel:
103 </para>
104
105 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
106 href="alsa-lib-kernel.xml"/>
107
108 <para>
109 In the Device Drivers &rArr; Sound card support &rArr; Advanced Linux
110 Sound Architecture section of the kernel configuration, select the
111 settings and drivers appropriate for your hardware. If necessary,
112 recompile and install your new kernel.
113 </para>
114
115 <indexterm zone="alsa-lib alsa-lib-kernel">
116 <primary sortas="d-ALSA">ALSA</primary>
117 </indexterm>
118
119 </sect2>
120
121 <sect2 role="installation">
122 <title>Installation of ALSA Library</title>
123
124 <para>
125 Install <application>ALSA Library</application> by
126 running the following commands:
127 </para>
128
129<screen><userinput>./configure &amp;&amp;
130make</userinput></screen>
131
132 <para>
133 If you have <application>Doxygen</application> installed and you wish to
134 build the library API documentation, run the following
135 commands from the top-level directory of the source tree:
136 </para>
137
138<screen remap="doc"><userinput>make doc</userinput></screen>
139
140 <para>
141 To test the results, issue: <command>make check</command>.
142 </para>
143
144 <para>
145 Now, as the <systemitem class="username">root</systemitem> user:
146 </para>
147
148<screen role="root"><userinput>make install</userinput></screen>
149
150 <para>
151 To install the API documentation, run the following command as
152 the <systemitem class="username">root</systemitem> user:
153 </para>
154
155<screen role="root"
156 remap="doc"><userinput>install -v -d -m755 /usr/share/doc/alsa-lib-&alsa-lib-version;/html/search &amp;&amp;
157install -v -m644 doc/doxygen/html/*.* \
158 /usr/share/doc/alsa-lib-&alsa-lib-version;/html &amp;&amp;
159install -v -m644 doc/doxygen/html/search/* \
160 /usr/share/doc/alsa-lib-&alsa-lib-version;/html/search</userinput></screen>
161
162 </sect2>
163
164 <sect2 role="configuration">
165 <title>Configuring ALSA Library</title>
166
167 <sect3 id="alsa-lib-config">
168 <title>Config Files</title>
169
170 <para>
171 <filename>~/.asoundrc</filename> and
172 <filename>/etc/asound.conf</filename>
173 </para>
174
175 <indexterm zone="alsa-lib alsa-lib-config">
176 <primary sortas="e-AA.asoundrc">~/.asoundrc</primary>
177 </indexterm>
178
179 <indexterm zone="alsa-lib alsa-lib-config">
180 <primary sortas="e-etc-asound.conf">/etc/asound.conf</primary>
181 </indexterm>
182
183 </sect3>
184
185 <sect3>
186 <title>Configuration Information</title>
187
188 <para>
189 The default <filename>alsa.conf</filename> is adequate for most
190 installations. For extra functionality and/or advanced control of your
191 sound device, you may need to create additional configuration files.
192 For information on the available configuration parameters, visit
193 <ulink url="https://www.alsa-project.org/main/index.php/Asoundrc"/>.
194 </para>
195
196 </sect3>
197
198 </sect2>
199
200 <sect2 role="content">
201 <title>Contents</title>
202
203 <segmentedlist>
204 <segtitle>Installed Program</segtitle>
205 <segtitle>Installed Library</segtitle>
206 <segtitle>Installed Directories</segtitle>
207
208 <seglistitem>
209 <seg>
210 aserver
211 </seg>
212 <seg>
213 libasound.so and
214 libatopology.so
215 </seg>
216 <seg>
217 /usr/include/alsa,
218 /usr/share/alsa and
219 /usr/share/doc/alsa-lib-&alsa-lib-version;
220 </seg>
221 </seglistitem>
222 </segmentedlist>
223
224 <variablelist>
225 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
226 <?dbfo list-presentation="list"?>
227 <?dbhtml list-presentation="table"?>
228
229 <varlistentry id="aserver">
230 <term><command>aserver</command></term>
231 <listitem>
232 <para>
233 is the ALSA server
234 </para>
235 <indexterm zone="alsa-lib aserver">
236 <primary sortas="b-aserver">aserver</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="libasound">
242 <term><filename class="libraryfile">libasound.so</filename></term>
243 <listitem>
244 <para>
245 contains the ALSA API functions
246 </para>
247 <indexterm zone="alsa-lib libasound">
248 <primary sortas="c-libasound">libasound.so</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="libatopology">
254 <term><filename class="libraryfile">libatopology.so</filename></term>
255 <listitem>
256 <para>
257 contains API functions for the ALSA topologies
258 </para>
259 <indexterm zone="alsa-lib libatopology">
260 <primary sortas="c-libatopology">libatopology.so</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 </variablelist>
266
267 </sect2>
268
269</sect1>
Note: See TracBrowser for help on using the repository browser.