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 sdl-download-http "https://github.com/libsdl-org/sdl12-compat/archive/release-&sdl-version;/sdl12-compat-release-&sdl-version;.tar.gz">
|
---|
8 | <!ENTITY sdl-download-ftp " ">
|
---|
9 | <!ENTITY sdl-md5sum "04ed17494dad2131b37e0300f8af31ec">
|
---|
10 | <!ENTITY sdl-size "452 KB">
|
---|
11 | <!ENTITY sdl-buildsize "7.1 MB">
|
---|
12 | <!ENTITY sdl-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="sdl" xreflabel="sdl12-compat-&sdl-version;">
|
---|
16 | <?dbhtml filename="sdl.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>sdl12-compat-&sdl-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="sdl">
|
---|
22 | <primary sortas="a-SDL">SDL</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to sdl12-compat</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The Simple DirectMedia Layer (<application>SDL</application>
|
---|
30 | for short) is a cross-platform library designed to make it easy to write
|
---|
31 | multimedia software, such as games and emulators. This code is a
|
---|
32 | compatibility layer; it provides a binary and source compatible API
|
---|
33 | for programs written against SDL 1.2, but it uses SDL 2.0 behind the scenes.
|
---|
34 | </para>
|
---|
35 |
|
---|
36 | &lfs122_checked;
|
---|
37 |
|
---|
38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
39 | <itemizedlist spacing="compact">
|
---|
40 | <listitem>
|
---|
41 | <para>
|
---|
42 | Download (HTTP): <ulink url="&sdl-download-http;"/>
|
---|
43 | </para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download (FTP): <ulink url="&sdl-download-ftp;"/>
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Download MD5 sum: &sdl-md5sum;
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Download size: &sdl-size;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Estimated disk space required: &sdl-buildsize;
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Estimated build time: &sdl-time;
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | </itemizedlist>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect3">SDL Dependencies</bridgehead>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
75 | <para role="required">
|
---|
76 | <xref linkend="cmake"/>,
|
---|
77 | <xref linkend="glu"/>, and
|
---|
78 | <xref linkend="sdl2"/>
|
---|
79 | </para>
|
---|
80 | </sect2>
|
---|
81 |
|
---|
82 | <sect2 role="installation">
|
---|
83 | <title>Installation of sdl12-compat</title>
|
---|
84 |
|
---|
85 | <para>
|
---|
86 | Install <application>sdl12-compat</application> by running the
|
---|
87 | following commands:
|
---|
88 | </para>
|
---|
89 |
|
---|
90 | <screen><userinput>mkdir build &&
|
---|
91 | cd build &&
|
---|
92 |
|
---|
93 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
94 | -D CMAKE_BUILD_TYPE=RELEASE \
|
---|
95 | .. &&
|
---|
96 | make</userinput></screen>
|
---|
97 |
|
---|
98 | <para>
|
---|
99 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
100 | </para>
|
---|
101 |
|
---|
102 | <screen role="root"><userinput>make install &&
|
---|
103 | rm -vf /usr/lib/libSDLmain.a</userinput></screen>
|
---|
104 |
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2 role="testing">
|
---|
108 | <title>Testing SDL</title>
|
---|
109 |
|
---|
110 | <para>
|
---|
111 | If you wish, test the <application>sdlcompat</application> package
|
---|
112 | using the included test programs. It is not required to install any of
|
---|
113 | the resulting binaries to validate the installation.
|
---|
114 | </para>
|
---|
115 |
|
---|
116 | <para>
|
---|
117 | You'll need to manually run all the test programs (they are listed in
|
---|
118 | the <filename>README</filename> file in this directory). Many of them
|
---|
119 | will need to be manually killed, and you'll need to turn your speakers
|
---|
120 | on with the volume at a suitable level.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | </sect2>
|
---|
124 |
|
---|
125 | <sect2 role="content">
|
---|
126 | <title>Contents</title>
|
---|
127 |
|
---|
128 | <segmentedlist>
|
---|
129 | <segtitle>Installed Program</segtitle>
|
---|
130 | <segtitle>Installed Libraries</segtitle>
|
---|
131 | <segtitle>Installed Directories</segtitle>
|
---|
132 |
|
---|
133 | <seglistitem>
|
---|
134 | <seg>sdl-config</seg>
|
---|
135 | <seg>libSDL.so</seg>
|
---|
136 | <seg>/usr/include/SDL</seg>
|
---|
137 | </seglistitem>
|
---|
138 | </segmentedlist>
|
---|
139 |
|
---|
140 | <variablelist>
|
---|
141 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
142 | <?dbfo list-presentation="list"?>
|
---|
143 | <?dbhtml list-presentation="table"?>
|
---|
144 |
|
---|
145 | <varlistentry id="sdl-config">
|
---|
146 | <term><command>sdl-config</command></term>
|
---|
147 | <listitem>
|
---|
148 | <para>
|
---|
149 | determines the compile and linker flags that should be used to
|
---|
150 | compile and link programs that use
|
---|
151 | <filename class="libraryfile">libSDL</filename>
|
---|
152 | </para>
|
---|
153 | <indexterm zone="sdl sdl-config">
|
---|
154 | <primary sortas="b-sdl-config">sdl-config</primary>
|
---|
155 | </indexterm>
|
---|
156 | </listitem>
|
---|
157 | </varlistentry>
|
---|
158 |
|
---|
159 | <varlistentry id="libsdl">
|
---|
160 | <term><filename class="libraryfile">libSDL.so</filename></term>
|
---|
161 | <listitem>
|
---|
162 | <para>
|
---|
163 | contains functions that provide compatibility links to SDL2
|
---|
164 | low level functions for audio,
|
---|
165 | keyboard, mouse, joystick, 3D hardware via OpenGL, and the
|
---|
166 | 2D frame buffer across multiple platforms
|
---|
167 | </para>
|
---|
168 | <indexterm zone="sdl libsdl">
|
---|
169 | <primary sortas="c-libsdl">libSDL.so</primary>
|
---|
170 | </indexterm>
|
---|
171 | </listitem>
|
---|
172 | </varlistentry>
|
---|
173 |
|
---|
174 | </variablelist>
|
---|
175 |
|
---|
176 | </sect2>
|
---|
177 |
|
---|
178 | </sect1>
|
---|