source: multimedia/libdriv/sdl.xml@ 68ad918

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/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-size          "2.5 MB">
  <!ENTITY sdl-buildsize     "33 MB">
  <!ENTITY sdl-time          "0.99 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>

<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 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 &amp;&amp;
make install</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>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>

<para>The <application><acronym>SDL</acronym></application> package contains 
the <userinput>Simple DirectMedia Layer</userinput> libraries.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>Simple DirectMedia Layer</title>
<para>The Simple DirectMedia Layer is a generic <acronym>API</acronym> that 
provides low level access to audio, keyboard, mouse, joystick, 
<acronym>3D</acronym> hardware via OpenGL, and <acronym>2D</acronym> frame 
buffer across multiple platforms.</para></sect3>

</sect2>

</sect1>