1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY sdl-download-http "http://www.libsdl.org/release/SDL-&sdl-version;.tar.gz">
|
---|
8 | <!ENTITY sdl-download-ftp " ">
|
---|
9 | <!ENTITY sdl-md5sum "80919ef556425ff82a8555ff40a579a0">
|
---|
10 | <!ENTITY sdl-size "2.6 MB">
|
---|
11 | <!ENTITY sdl-buildsize "36 MB">
|
---|
12 | <!ENTITY sdl-time "0.8 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="sdl" xreflabel="SDL-&sdl-version;">
|
---|
16 | <?dbhtml filename="sdl.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | <keywordset>
|
---|
22 | <keyword role="package">SDL-&sdl-version;.tar</keyword>
|
---|
23 | <keyword role="ftpdir">SDL</keyword>
|
---|
24 | </keywordset>
|
---|
25 | </sect1info>
|
---|
26 |
|
---|
27 | <title>SDL-&sdl-version;</title>
|
---|
28 |
|
---|
29 | <indexterm zone="sdl">
|
---|
30 | <primary sortas="a-SDL">SDL</primary>
|
---|
31 | </indexterm>
|
---|
32 |
|
---|
33 | <sect2 role="package">
|
---|
34 | <title>Introduction to SDL</title>
|
---|
35 |
|
---|
36 | <para>The Simple DirectMedia Layer (<application>SDL</application>
|
---|
37 | for short) is a cross-platform library designed to make it easy to write
|
---|
38 | multimedia software, such as games and emulators.</para>
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>Download (HTTP): <ulink url="&sdl-download-http;"/></para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>Download (FTP): <ulink url="&sdl-download-ftp;"/></para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download MD5 sum: &sdl-md5sum;</para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Download size: &sdl-size;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Estimated disk space required: &sdl-buildsize;</para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Estimated build time: &sdl-time;</para>
|
---|
59 | </listitem>
|
---|
60 | </itemizedlist>
|
---|
61 |
|
---|
62 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
63 | <itemizedlist spacing="compact">
|
---|
64 | <listitem>
|
---|
65 | <para>Required patch: <ulink
|
---|
66 | url="&patch-root;/SDL-&sdl-version;-gcc4-1.patch"/></para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect3">SDL Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
73 | <para role="optional"><xref linkend="alsa"/>,
|
---|
74 | <xref linkend="esound"/>,
|
---|
75 | <xref linkend="arts"/>,
|
---|
76 | <xref linkend="nas"/>,
|
---|
77 | <xref linkend="NASM"/>,
|
---|
78 | X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>),
|
---|
79 | <xref linkend="aalib"/>,
|
---|
80 | <ulink url="http://www.directfb.org/">DirectFB</ulink>,
|
---|
81 | <ulink url="http://www.svgalib.org/">SVGAlib</ulink>,
|
---|
82 | <ulink url="http://www.gnu.org/software/pth/">GNU Pth</ulink>,
|
---|
83 | <ulink url="http://www.trolltech.com/download/qtopia/">Qtopia</ulink> and
|
---|
84 | <ulink url="http://picogui.org/">PicoGUI</ulink></para>
|
---|
85 |
|
---|
86 | </sect2>
|
---|
87 |
|
---|
88 | <sect2 role="installation">
|
---|
89 | <title>Installation of SDL</title>
|
---|
90 |
|
---|
91 | <para>Install <application>SDL</application> by running the
|
---|
92 | following commands:</para>
|
---|
93 |
|
---|
94 | <screen><userinput>patch -Np1 -i ../SDL-&sdl-version;-gcc4-1.patch &&
|
---|
95 | ./configure --prefix=/usr --disable-debug &&
|
---|
96 | make</userinput></screen>
|
---|
97 |
|
---|
98 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
99 |
|
---|
100 | <screen role="root"><userinput>make install &&
|
---|
101 | install -v -m755 -d /usr/share/doc/SDL-&sdl-version;/html &&
|
---|
102 | install -v -m644 docs/html/*.html /usr/share/doc/SDL-&sdl-version;/html</userinput></screen>
|
---|
103 |
|
---|
104 | </sect2>
|
---|
105 |
|
---|
106 | <sect2 role="commands">
|
---|
107 | <title>Command Explanations</title>
|
---|
108 |
|
---|
109 | <para><parameter>--disable-debug</parameter>: This switch configures
|
---|
110 | <application>SDL</application> to build with aggressive
|
---|
111 | optimizations.</para>
|
---|
112 |
|
---|
113 | <para><option>--enable-video-aalib</option>: This switch
|
---|
114 | is required to build <application>SDL</application>
|
---|
115 | with AAlib video support.</para>
|
---|
116 |
|
---|
117 | </sect2>
|
---|
118 |
|
---|
119 | <sect2 role="testing">
|
---|
120 | <title>Testing SDL</title>
|
---|
121 |
|
---|
122 | <para>It is advisable to test the installation of
|
---|
123 | <application>SDL</application> using the included
|
---|
124 | test programs. It is not required to install any of the resulting binaries
|
---|
125 | to validate the installation. Issue the following commands to build the
|
---|
126 | test programs:</para>
|
---|
127 |
|
---|
128 | <screen><userinput>cd test &&
|
---|
129 | ./configure &&
|
---|
130 | make</userinput></screen>
|
---|
131 |
|
---|
132 | <para>You'll need to manually run all the test programs.</para>
|
---|
133 |
|
---|
134 | </sect2>
|
---|
135 |
|
---|
136 | <sect2 role="configuration">
|
---|
137 | <title>Configuring SDL</title>
|
---|
138 |
|
---|
139 | <sect3>
|
---|
140 | <title>Configuration Information</title>
|
---|
141 |
|
---|
142 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../../lib-config.xml"/>
|
---|
143 |
|
---|
144 | </sect3>
|
---|
145 |
|
---|
146 | </sect2>
|
---|
147 |
|
---|
148 | <sect2 role="content">
|
---|
149 | <title>Contents</title>
|
---|
150 |
|
---|
151 | <segmentedlist>
|
---|
152 | <segtitle>Installed Program</segtitle>
|
---|
153 | <segtitle>Installed Libraries</segtitle>
|
---|
154 | <segtitle>Installed Directories</segtitle>
|
---|
155 |
|
---|
156 | <seglistitem>
|
---|
157 | <seg>sdl-config</seg>
|
---|
158 | <seg>libSDL*.[so,a]</seg>
|
---|
159 | <seg>/usr/include/SDL and /usr/share/doc/SDL-&sdl-version;</seg>
|
---|
160 | </seglistitem>
|
---|
161 | </segmentedlist>
|
---|
162 |
|
---|
163 | <variablelist>
|
---|
164 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
165 | <?dbfo list-presentation="list"?>
|
---|
166 | <?dbhtml list-presentation="table"?>
|
---|
167 |
|
---|
168 | <varlistentry id="sdl-config">
|
---|
169 | <term><command>sdl-config</command></term>
|
---|
170 | <listitem>
|
---|
171 | <para>determines the compile and linker flags that should be used to
|
---|
172 | compile and link programs that use
|
---|
173 | <filename class='libraryfile'>libSDL</filename>.</para>
|
---|
174 | <indexterm zone="sdl sdl-config">
|
---|
175 | <primary sortas="b-sdl-config">sdl-config</primary>
|
---|
176 | </indexterm>
|
---|
177 | </listitem>
|
---|
178 | </varlistentry>
|
---|
179 |
|
---|
180 | <varlistentry id="libsdl">
|
---|
181 | <term><filename class='libraryfile'>libSDL*.[so,a]</filename></term>
|
---|
182 | <listitem>
|
---|
183 | <para> libraries provide low level access to audio, keyboard, mouse,
|
---|
184 | joystick, 3D hardware via OpenGL, and
|
---|
185 | 2D frame buffer across multiple platforms.</para>
|
---|
186 | <indexterm zone="sdl libsdl">
|
---|
187 | <primary sortas="c-libsdl">libSDL*.[so,a]</primary>
|
---|
188 | </indexterm>
|
---|
189 | </listitem>
|
---|
190 | </varlistentry>
|
---|
191 |
|
---|
192 | </variablelist>
|
---|
193 |
|
---|
194 | </sect2>
|
---|
195 |
|
---|
196 | </sect1>
|
---|