source: multimedia/libdriv/sdl.xml@ 48c17bf2

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY sdl-download-http "http://www.libsdl.org/release/SDL-&sdl-version;.tar.gz">
  <!ENTITY sdl-download-ftp  " ">
  <!ENTITY sdl-md5sum        "37aaf9f069f9c2c18856022f35de9f8c">
  <!ENTITY sdl-size          "2.6 MB">
  <!ENTITY sdl-buildsize     "36 MB">
  <!ENTITY sdl-time          "0.8 SBU">
]>

<sect1 id="sdl" xreflabel="SDL-&sdl-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="sdl.html"?>
<title>SDL-&sdl-version;</title>
<indexterm zone="sdl">
<primary sortas="a-SDL">SDL</primary>
</indexterm>

<sect2>
<title>Introduction to <application><acronym>SDL</acronym></application></title>

<para>The Simple DirectMedia Layer 
(<application><acronym>SDL</acronym></application> for short) is a 
cross-platform library designed to make it easy to write multimedia software, 
such as games and emulators.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): 
<ulink url="&sdl-download-http;"/></para></listitem>
<listitem><para>Download (FTP): 
<ulink url="&sdl-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 sum: &sdl-md5sum;</para></listitem>
<listitem><para>Download size: &sdl-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&sdl-buildsize;</para></listitem>
<listitem><para>Estimated build time: 
&sdl-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application><acronym>SDL</acronym></application> 
dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="alsa"/>, 
<xref linkend="esound"/>,
<xref linkend="arts"/>,
<xref linkend="nas"/>,
<xref linkend="NASM"/>, 
X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>),
<xref linkend="aalib"/>,
<ulink url="http://www.directfb.org/">DirectFB</ulink>, 
<ulink url="http://www.svgalib.org/">SVGAlib</ulink>, 
<ulink url="http://www.gnu.org/software/pth/">GNU Pth</ulink>, 
<ulink url="http://www.trolltech.com/download/qtopia/">Qtopia</ulink> and 
<ulink url="http://picogui.org/">PicoGUI</ulink></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>SDL</acronym></application></title>

<para>Install <application><acronym>SDL</acronym></application> by running the 
following commands:</para>

<screen><userinput><command>./configure --prefix=/usr --disable-debug &amp;&amp;
make</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/SDL-1.2.8/html &amp;&amp;
install -v -m644 docs/html/*.html /usr/share/doc/SDL-1.2.8/html</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><parameter>--disable-debug</parameter>: This switch configures
<application><acronym>SDL</acronym></application> to build with aggressive 
optimizations.</para>

<para><option>--enable-video-aalib</option>: This switch
is required to build <application><acronym>SDL</acronym></application>
with <acronym>AA</acronym>lib video support.</para>

</sect2>

<sect2>
<title>Testing <application><acronym>SDL</acronym></application></title>

<para>It is advisable to test the installation of 
<application><acronym>SDL</acronym></application> using the included
test programs. It is not required to install any of the resulting binaries
to validate the installation. Issue the following commands to build the
test programs:</para>

<screen><userinput><command>cd test &amp;&amp;
./configure &amp;&amp;
make</command></userinput></screen>

<para>You'll need to manually run all the test programs.</para>
    
</sect2>

<sect2>
<title>Configuring <application><acronym>SDL</acronym></application></title>

<sect3><title>Configuration Information</title>
<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../../lib-config.xml"/>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Program</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
   
<seglistitem>
<seg>sdl-config</seg>
<seg>libSDL*.[so,a]</seg>
<seg>/usr/include/SDL and /usr/share/doc/SDL-&sdl-version;</seg>
</seglistitem>
</segmentedlist>
    
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
      
<varlistentry id="sdl-config">
<term><command>sdl-config</command></term>
<listitem>
<para>determines the compile and linker flags that should be used to 
compile and link programs that use 
<filename class='libraryfile'>libSDL</filename>.</para>
<indexterm zone="sdl sdl-config">
<primary sortas="b-sdl-config">sdl-config</primary>
</indexterm>
</listitem>
</varlistentry>

<varlistentry id="libsdl">
<term><filename class='libraryfile'>libSDL*.[so,a]</filename></term>
<listitem>
<para> libraries provide low level access to audio, keyboard, mouse,
joystick, <acronym>3D</acronym> hardware via OpenGL, and
<acronym>2D</acronym> frame buffer across multiple platforms.</para>
<indexterm zone="sdl libsdl">
<primary sortas="c-libsdl">libSDL*.[so,a]</primary>
</indexterm>
</listitem>
</varlistentry>
 
</variablelist>

</sect2>

</sect1>