source: multimedia/libdriv/sdl2.xml@ 98d1db55

10.0 10.1 11.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 98d1db55 was 98d1db55, checked in by Pierre Labastie <pieere@…>, 5 years ago

Another typo in SDL2

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@18555 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 "d4055424d556b4a908aa76fad63abd3c">
10 <!ENTITY sdl2-size "4.0 MB">
11 <!ENTITY sdl2-buildsize "202 MB (with docs)">
12 <!ENTITY sdl2-time "0.9 SBU">
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 &lfs80_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 <phrase revision="systemd"><xref linkend="ibus"/></phrase>
68 <phrase revision="sysv"><ulink url="https://github.com/ibus/ibus/wiki">ibus</ulink>
69 </phrase>,
70 <xref linkend="nasm"/>,
71 <xref linkend="pulseaudio"/>,
72 <xref linkend="x-window-system"/>,
73 <ulink url="http://pkgs.fedoraproject.org/repo/pkgs/directfb/">DirectFB</ulink>, and
74 <ulink url="https://fcitx-im.org/">fcitx</ulink>
75 </para>
76
77 <para condition="html" role="usernotes">User Notes:
78 <ulink url="&blfs-wiki;/sdl"/></para>
79
80 </sect2>
81
82 <sect2 role="installation">
83 <title>Installation of SDL2</title>
84
85 <para>Install <application>SDL2</application> by running the
86 following commands:</para>
87
88<screen><userinput>./configure --prefix=/usr &amp;&amp;
89make</userinput></screen>
90
91 <para>
92 If you have <xref linkend="doxygen"/> installed and want to build the
93 html documentation, run the following commands:
94 </para>
95
96<screen><userinput>pushd docs &amp;&amp;
97 doxygen &amp;&amp;
98popd</userinput></screen>
99
100 <note>
101 <para>If you wish to build and run the package regression
102 tests, do not delete the static libraries below until after
103 the tests are built.</para>
104 </note>
105
106 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
107
108<screen role="root"><userinput>make install &amp;&amp;
109rm -v /usr/lib/libSDL2*.a</userinput></screen>
110
111 <para>If you built the documentation, install it as the <systemitem
112 class="username">root</systemitem> user:</para>
113
114<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/SDL2-&sdl2-version;/html &amp;&amp;
115cp -Rv docs/output/html/* /usr/share/doc/SDL2-&sdl2-version;/html</userinput></screen>
116
117 </sect2>
118
119 <sect2 role="testing">
120 <title>Testing SDL2</title>
121
122 <para>If you wish to, test the installation of
123 <application>SDL2</application> using the included
124 test programs.
125 None of the resulting binaries need to be installed.
126 Issue the following commands to build the
127 test programs:</para>
128
129<screen><userinput>cd test &amp;&amp;
130./configure &amp;&amp;
131make</userinput></screen>
132
133 <para>Each of the test programs (they are listed in the
134 <filename>README</filename> file in this directory) will need to be run
135 individually. Many of them will need to be manually killed. Additionally,
136 speakers need to be on with the volume at a suitable level.</para>
137
138 </sect2>
139
140 <sect2 role="commands">
141 <title>Command Explanations</title>
142
143 <para><command>rm -v /usr/lib/libSDL2*.a</command>: Normally
144 static libraries can be disabled with a <option>--disable-static</option>
145 option to configure, but that breaks the build in this package.</para>
146
147 <para><option>--disable-alsa-shared</option>: This switch disables
148 dynamically loading ALSA shared libraries.</para>
149
150 <para><option>--disable-sdl-dlopen</option>: This switch disables using
151 dlopen for shared object loading. Loading image backend libraries like
152 libpng dynamically on the fly does not work.</para>
153
154 <para><option>--disable-x11-shared</option>: This switch disables
155 dynamically loading X11 shared libraries.</para>
156
157 </sect2>
158
159 <sect2 role="configuration">
160 <title>Configuring SDL</title>
161
162 <sect3>
163 <title>Configuration Information</title>
164
165 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
166 href="../../xincludes/lib-config.xml"/>
167
168 </sect3>
169
170 </sect2>
171
172 <sect2 role="content">
173 <title>Contents</title>
174
175 <segmentedlist>
176 <segtitle>Installed Program</segtitle>
177 <segtitle>Installed Libraries</segtitle>
178 <segtitle>Installed Directories</segtitle>
179
180 <seglistitem>
181 <seg>sdl2-config</seg>
182 <seg>libSDL2.so</seg>
183 <seg>/usr/include/SDL2 and
184 /usr/share/doc/SDL-&sdl2-version;</seg>
185 </seglistitem>
186 </segmentedlist>
187
188 <variablelist>
189 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
190 <?dbfo list-presentation="list"?>
191 <?dbhtml list-presentation="table"?>
192
193 <varlistentry id="sdl2-config">
194 <term><command>sdl2-config</command></term>
195 <listitem>
196 <para>determines the compile and linker flags that should be used to
197 compile and link programs that use
198 <filename class='libraryfile'>libSDL2</filename>.</para>
199 <indexterm zone="sdl2 sdl2-config">
200 <primary sortas="b-sdl2-config">sdl2-config</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="libsdl2">
206 <term><filename class='libraryfile'>libSDL2.so</filename></term>
207 <listitem>
208 <para> library provides low level access to audio, keyboard, mouse,
209 joystick, 3D hardware via OpenGL, and
210 2D frame buffer across multiple platforms.</para>
211 <indexterm zone="sdl2 libsdl2">
212 <primary sortas="c-libsdl2">libSDL2.so</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216
217 </variablelist>
218
219 </sect2>
220
221</sect1>
Note: See TracBrowser for help on using the repository browser.