source: multimedia/libdriv/sdl2.xml@ 16dfae9

10.0 10.1 11.0 11.1 11.2 9.0 9.1 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 16dfae9 was 16dfae9, checked in by Douglas R. Reno <renodr@…>, 3 years ago

Refer to the correct SDL major version in the SDL2 page

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21910 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 7.1 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 sdl2-download-http "http://www.libsdl.org/release/SDL2-&sdl2-version;.tar.gz">
8 <!ENTITY sdl2-download-ftp " ">
9 <!ENTITY sdl2-md5sum "5a2114f2a6f348bdab5bf52b994811db">
10 <!ENTITY sdl2-size "5.3 MB">
11 <!ENTITY sdl2-buildsize "169 MB (with docs)">
12 <!ENTITY sdl2-time "0.4 SBU (using parallelism=4; with docs)">
13]>
14
15<sect1 id="sdl2" xreflabel="SDL2-&sdl2-version;">
16 <?dbhtml filename="sdl2.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>SDL2-&sdl2-version;</title>
24
25 <indexterm zone="sdl2">
26 <primary sortas="a-SDL2">SDL2</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to SDL2</title>
31
32 <para>The Simple DirectMedia Layer Version 2
33 (<application>SDL2</application> for short) is a cross-platform library
34 designed to make it easy to write multimedia software, such as games and
35 emulators.</para>
36
37 &lfs84_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>Download (HTTP): <ulink url="&sdl2-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&sdl2-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &sdl2-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &sdl2-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &sdl2-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &sdl2-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <bridgehead renderas="sect3">SDL2 Dependencies</bridgehead>
62
63 <bridgehead renderas="sect4">Optional</bridgehead>
64 <para role="optional">
65 <xref linkend="alsa"/>,
66 <xref linkend="doxygen"/> (to create documentation),
67 <xref linkend="ibus"/>,
68 <xref linkend="nasm"/>,
69 <xref linkend="pulseaudio"/>,
70 <xref linkend="x-window-system"/>,
71 <ulink url="http://pkgs.fedoraproject.org/repo/pkgs/directfb/">DirectFB</ulink>, and
72 <ulink url="https://fcitx-im.org/">fcitx</ulink>
73 </para>
74
75 <para condition="html" role="usernotes">User Notes:
76 <ulink url="&blfs-wiki;/sdl"/></para>
77
78 </sect2>
79
80 <sect2 role="installation">
81 <title>Installation of SDL2</title>
82
83 <para>Install <application>SDL2</application> by running the
84 following commands:</para>
85
86<screen><userinput>./configure --prefix=/usr &amp;&amp;
87make</userinput></screen>
88
89 <para>
90 If you have <xref linkend="doxygen"/> installed and want to build the
91 html documentation, run the following commands:
92 </para>
93
94<screen remap="doc"><userinput>pushd docs &amp;&amp;
95 doxygen &amp;&amp;
96popd</userinput></screen>
97
98 <note>
99 <para>If you wish to build and run the package regression
100 tests, do not delete the static libraries below until after
101 the tests are built.</para>
102 </note>
103
104 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
105
106<screen role="root"><userinput>make install &amp;&amp;
107rm -v /usr/lib/libSDL2*.a</userinput></screen>
108
109 <para>If you built the documentation, install it as the <systemitem
110 class="username">root</systemitem> user:</para>
111
112<screen role="root"
113 remap="doc"><userinput>install -v -m755 -d /usr/share/doc/SDL2-&sdl2-version;/html &amp;&amp;
114cp -Rv docs/output/html/* /usr/share/doc/SDL2-&sdl2-version;/html</userinput></screen>
115
116 </sect2>
117<!--
118 The tests are broken for version 2.0.10. It cannot find libSDL2_test*.
119
120 <sect2 role="testing">
121 <title>Testing SDL2</title>
122
123 <para>If you wish to, test the installation of
124 <application>SDL2</application> using the included
125 test programs.
126 None of the resulting binaries need to be installed.
127 Issue the following commands to build the
128 test programs:</para>
129
130<screen><userinput>cd test &amp;&amp;
131./configure &amp;&amp;
132make</userinput></screen>
133
134 <para>Each of the test programs (they are listed in the
135 <filename>README</filename> file in this directory) will need to be run
136 individually. Many of them will need to be manually killed. Additionally,
137 speakers need to be on with the volume at a suitable level.</para>
138
139 </sect2>
140-->
141 <sect2 role="commands">
142 <title>Command Explanations</title>
143
144 <para><command>rm -v /usr/lib/libSDL2*.a</command>: Normally
145 static libraries can be disabled with a <option>--disable-static</option>
146 option to configure, but that breaks the build in this package.</para>
147
148 <para><option>--disable-alsa-shared</option>: This switch disables
149 dynamically loading ALSA shared libraries.</para>
150
151 <para><option>--disable-sdl-dlopen</option>: This switch disables using
152 dlopen for shared object loading. Loading image backend libraries like
153 libpng dynamically on the fly does not work.</para>
154
155 <para><option>--disable-x11-shared</option>: This switch disables
156 dynamically loading X11 shared libraries.</para>
157
158 </sect2>
159
160 <sect2 role="configuration">
161 <title>Configuring SDL2</title>
162
163 <sect3>
164 <title>Configuration Information</title>
165
166 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
167 href="../../xincludes/lib-config.xml"/>
168
169 </sect3>
170
171 </sect2>
172
173 <sect2 role="content">
174 <title>Contents</title>
175
176 <segmentedlist>
177 <segtitle>Installed Program</segtitle>
178 <segtitle>Installed Libraries</segtitle>
179 <segtitle>Installed Directories</segtitle>
180
181 <seglistitem>
182 <seg>sdl2-config</seg>
183 <seg>libSDL2.so</seg>
184 <seg>/usr/include/SDL2 and
185 /usr/share/doc/SDL-&sdl2-version;</seg>
186 </seglistitem>
187 </segmentedlist>
188
189 <variablelist>
190 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
191 <?dbfo list-presentation="list"?>
192 <?dbhtml list-presentation="table"?>
193
194 <varlistentry id="sdl2-config">
195 <term><command>sdl2-config</command></term>
196 <listitem>
197 <para>determines the compile and linker flags that should be used to
198 compile and link programs that use
199 <filename class='libraryfile'>libSDL2</filename>.</para>
200 <indexterm zone="sdl2 sdl2-config">
201 <primary sortas="b-sdl2-config">sdl2-config</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 <varlistentry id="libsdl2">
207 <term><filename class='libraryfile'>libSDL2.so</filename></term>
208 <listitem>
209 <para> library provides low level access to audio, keyboard, mouse,
210 joystick, 3D hardware via OpenGL, and
211 2D frame buffer across multiple platforms.</para>
212 <indexterm zone="sdl2 libsdl2">
213 <primary sortas="c-libsdl2">libSDL2.so</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 </variablelist>
219
220 </sect2>
221
222</sect1>
Note: See TracBrowser for help on using the repository browser.