[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[48b7295] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[86698d8] | 6 |
|
---|
[a80c832] | 7 | <!ENTITY sdl-download-http "https://github.com/libsdl-org/sdl12-compat/archive/release-&sdl-version;/sdl12-compat-release-&sdl-version;.tar.gz">
|
---|
[68ad918] | 8 | <!ENTITY sdl-download-ftp " ">
|
---|
[ffc17327] | 9 | <!ENTITY sdl-md5sum "04ed17494dad2131b37e0300f8af31ec">
|
---|
[320b871] | 10 | <!ENTITY sdl-size "452 KB">
|
---|
[ffc17327] | 11 | <!ENTITY sdl-buildsize "7.1 MB">
|
---|
[676ee3a7] | 12 | <!ENTITY sdl-time "less than 0.1 SBU">
|
---|
[48b7295] | 13 | ]>
|
---|
[4a21942] | 14 |
|
---|
[676ee3a7] | 15 | <sect1 id="sdl" xreflabel="sdl12-compat-&sdl-version;">
|
---|
[576a230] | 16 | <?dbhtml filename="sdl.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[676ee3a7] | 19 | <title>sdl12-compat-&sdl-version;</title>
|
---|
[576a230] | 20 |
|
---|
| 21 | <indexterm zone="sdl">
|
---|
| 22 | <primary sortas="a-SDL">SDL</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[676ee3a7] | 26 | <title>Introduction to sdl12-compat</title>
|
---|
[576a230] | 27 |
|
---|
[2eeb8695] | 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
|
---|
[e440af5] | 31 | multimedia software, such as games and emulators. This code is a
|
---|
| 32 | compatibility layer; it provides a binary and source compatible API
|
---|
[676ee3a7] | 33 | for programs written against SDL 1.2, but it uses SDL 2.0 behind the scenes.
|
---|
[2eeb8695] | 34 | </para>
|
---|
[576a230] | 35 |
|
---|
[3c9b5e9] | 36 | &lfs122_checked;
|
---|
[98d5a95] | 37 |
|
---|
[576a230] | 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
[2eeb8695] | 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&sdl-download-http;"/>
|
---|
| 43 | </para>
|
---|
[576a230] | 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
[2eeb8695] | 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&sdl-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
[576a230] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[2eeb8695] | 51 | <para>
|
---|
| 52 | Download MD5 sum: &sdl-md5sum;
|
---|
| 53 | </para>
|
---|
[576a230] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[2eeb8695] | 56 | <para>
|
---|
| 57 | Download size: &sdl-size;
|
---|
| 58 | </para>
|
---|
[576a230] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[2eeb8695] | 61 | <para>
|
---|
| 62 | Estimated disk space required: &sdl-buildsize;
|
---|
| 63 | </para>
|
---|
[576a230] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[2eeb8695] | 66 | <para>
|
---|
| 67 | Estimated build time: &sdl-time;
|
---|
| 68 | </para>
|
---|
[576a230] | 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
[93d50f5] | 72 | <bridgehead renderas="sect3">SDL Dependencies</bridgehead>
|
---|
[576a230] | 73 |
|
---|
[676ee3a7] | 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 75 | <para role="required">
|
---|
[973ea7c] | 76 | <xref linkend="cmake"/>,
|
---|
| 77 | <xref linkend="glu"/>, and
|
---|
[676ee3a7] | 78 | <xref linkend="sdl2"/>
|
---|
[f7a7e27] | 79 | </para>
|
---|
[576a230] | 80 | </sect2>
|
---|
| 81 |
|
---|
| 82 | <sect2 role="installation">
|
---|
[676ee3a7] | 83 | <title>Installation of sdl12-compat</title>
|
---|
[576a230] | 84 |
|
---|
[2eeb8695] | 85 | <para>
|
---|
[676ee3a7] | 86 | Install <application>sdl12-compat</application> by running the
|
---|
[2eeb8695] | 87 | following commands:
|
---|
| 88 | </para>
|
---|
[576a230] | 89 |
|
---|
[676ee3a7] | 90 | <screen><userinput>mkdir build &&
|
---|
| 91 | cd build &&
|
---|
[cf67717] | 92 |
|
---|
[cbfa153] | 93 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
| 94 | -D CMAKE_BUILD_TYPE=RELEASE \
|
---|
[676ee3a7] | 95 | .. &&
|
---|
[576a230] | 96 | make</userinput></screen>
|
---|
| 97 |
|
---|
[2eeb8695] | 98 | <para>
|
---|
| 99 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 100 | </para>
|
---|
[576a230] | 101 |
|
---|
| 102 | <screen role="root"><userinput>make install &&
|
---|
[676ee3a7] | 103 | rm -vf /usr/lib/libSDLmain.a</userinput></screen>
|
---|
[48b7295] | 104 |
|
---|
[576a230] | 105 | </sect2>
|
---|
[48b7295] | 106 |
|
---|
[4f2f35c6] | 107 | <sect2 role="testing">
|
---|
| 108 | <title>Testing SDL</title>
|
---|
[48b7295] | 109 |
|
---|
[2eeb8695] | 110 | <para>
|
---|
[676ee3a7] | 111 | If you wish, test the <application>sdlcompat</application> package
|
---|
[2eeb8695] | 112 | using the included test programs. It is not required to install any of
|
---|
[e440af5] | 113 | the resulting binaries to validate the installation.
|
---|
[2eeb8695] | 114 | </para>
|
---|
[48c17bf2] | 115 |
|
---|
[2eeb8695] | 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>
|
---|
[5886225] | 122 |
|
---|
| 123 | </sect2>
|
---|
| 124 |
|
---|
[576a230] | 125 | <sect2 role="content">
|
---|
| 126 | <title>Contents</title>
|
---|
[48b7295] | 127 |
|
---|
[576a230] | 128 | <segmentedlist>
|
---|
| 129 | <segtitle>Installed Program</segtitle>
|
---|
| 130 | <segtitle>Installed Libraries</segtitle>
|
---|
| 131 | <segtitle>Installed Directories</segtitle>
|
---|
[d7ecaa6] | 132 |
|
---|
[576a230] | 133 | <seglistitem>
|
---|
| 134 | <seg>sdl-config</seg>
|
---|
[676ee3a7] | 135 | <seg>libSDL.so</seg>
|
---|
| 136 | <seg>/usr/include/SDL</seg>
|
---|
[576a230] | 137 | </seglistitem>
|
---|
| 138 | </segmentedlist>
|
---|
[d7ecaa6] | 139 |
|
---|
[576a230] | 140 | <variablelist>
|
---|
| 141 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 142 | <?dbfo list-presentation="list"?>
|
---|
| 143 | <?dbhtml list-presentation="table"?>
|
---|
[d7ecaa6] | 144 |
|
---|
[576a230] | 145 | <varlistentry id="sdl-config">
|
---|
| 146 | <term><command>sdl-config</command></term>
|
---|
| 147 | <listitem>
|
---|
[2eeb8695] | 148 | <para>
|
---|
| 149 | determines the compile and linker flags that should be used to
|
---|
| 150 | compile and link programs that use
|
---|
[4c24eb0a] | 151 | <filename class="libraryfile">libSDL</filename>
|
---|
[2eeb8695] | 152 | </para>
|
---|
[576a230] | 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">
|
---|
[4c24eb0a] | 160 | <term><filename class="libraryfile">libSDL.so</filename></term>
|
---|
[576a230] | 161 | <listitem>
|
---|
[2eeb8695] | 162 | <para>
|
---|
[676ee3a7] | 163 | contains functions that provide compatibility links to SDL2
|
---|
| 164 | low level functions for audio,
|
---|
[30e5872d] | 165 | keyboard, mouse, joystick, 3D hardware via OpenGL, and the
|
---|
[4c24eb0a] | 166 | 2D frame buffer across multiple platforms
|
---|
[2eeb8695] | 167 | </para>
|
---|
[576a230] | 168 | <indexterm zone="sdl libsdl">
|
---|
[66d82600] | 169 | <primary sortas="c-libsdl">libSDL.so</primary>
|
---|
[576a230] | 170 | </indexterm>
|
---|
| 171 | </listitem>
|
---|
| 172 | </varlistentry>
|
---|
[d7ecaa6] | 173 |
|
---|
[576a230] | 174 | </variablelist>
|
---|
[48b7295] | 175 |
|
---|
[576a230] | 176 | </sect2>
|
---|
[f45b1953] | 177 |
|
---|
| 178 | </sect1>
|
---|