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