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