source: general/graphlib/directfb.xml@ 52d29f7

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 DirectFB-download-http "http://www.directfb.org/download/DirectFB/DirectFB-&DirectFB-version;.tar.gz">
<!ENTITY DirectFB-download-ftp " ">
<!ENTITY DirectFB-size "1.3 MB">
<!ENTITY DirectFB-buildsize "13 MB">
<!ENTITY DirectFB-time "0.65 SBU">

]>

<sect1 id="DirectFB" xreflabel="DirectFB-&DirectFB-version;">
<?dbhtml filename="DirectFB.html"?>
<title>DirectFB-&DirectFB-version;</title>

<sect2>
<title>Introduction to <application>DirectFB</application></title>
                                                                               
<para><application>DirectFB</application> is a graphics library on top of the Linux frame buffer
device. It offers maximum hardware accelerated performance at a
minimum of resource usage and overhead.</para>
                                                                               
<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink url="&DirectFB-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink url="&DirectFB-download-ftp;"/></para></listitem>
<listitem><para>Download size: &DirectFB-size;</para></listitem>
<listitem><para>Estimated Disk space required: &DirectFB-buildsize;</para></listitem>
<listitem><para>Estimated build time: &DirectFB-time;</para></listitem></itemizedlist>
</sect3>
                                                                               
<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Optional image and video providers: <ulink
url="http://www.directfb.org/download/DirectFB-extra/DirectFB-extra-0.9.16.tar.gz"/>
</para></listitem>
</itemizedlist></sect3>
                                                                               
<sect3><title><application>DirectFB</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="freetype2"/>, <xref linkend="libjpeg"/> and
<xref linkend="libpng"/>
</para></sect4>
<sect4><title>Optional</title>
<para><xref linkend="SDL"/>, <xref linkend="libmpeg3"/>
<xref linkend="pkgconfig"/>, <xref linkend="imlib2"/>, <xref
linkend="openquicktime"/> and <xref linkend="avifile"/>
</para></sect4>
</sect3>
                                                                               
</sect2>

<sect2>
<title>Installation of <application>DirectFB</application></title>
                                                                               
<note><para>DirectFB needs a Linux kernel with frame buffer support. Check
the documentation in the kernel tree
(<filename class="directory">/usr/src/linux/Documentation/fb/</filename>)
on how to enable the frame buffer device for your graphics
card.</para></note>
                                                                               
<para>Install <application>DirectFB</application> by running the
following commands:</para>
                                                                               
<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>
                                                                               
<para>If you decided to add any optional image and video providers, then you
have to install the DirectFB-extra package too:</para>
                                                                               
<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>
                                                                               
<note><para>The current version of avifile does not work with DirectFB.
You have to use the avifile version which can be found at
<ulink url="http://www.directfb.org/download/contrib/"/> or alternatively disable the
avifile video provider by calling configure with
<command>--disable-avifile</command>.</para></note>
                                                                               
</sect2>

<sect2>
<title>Configuring DirectFB</title>
                                                                               
<sect3><title>Config files</title>
                                                                               
<para><filename>/etc/directfbrc</filename>,
<filename>~/.directfbrc</filename></para>
</sect3>
                                                                               
<sect3><title>Configuration information</title>
                                                                               
<para>DirectFB is shipped with reasonable defaults but you might have to
tweak things. There are several ways to do this. You may edit the
system-wide configuration file <filename>/etc/directfbrc</filename>, the user-specific
<filename>~/.directfbrc</filename> or you may configure the DirectFB application via the
command-line. Consult the directfbrc(5) manual page for details.</para>
</sect3>
                                                                               
</sect2>

<sect2>
<title>Contents</title>
                                                                               
<para>The DirectFB package provides <command>dfbdump</command>,
<command>dfbg</command>, <command>dfbinfo</command>,
<command>dfblayer</command>, <command>directfb-config</command>,
<command>directfb-csource</command> and <filename
class="libraryfile">libdirectfb</filename> libraries.</para>
                                                                               
</sect2>
                                                                               
<sect2><title>Description</title>
                                                                               
<sect3><title>dfbdump</title>
<para> This is a simple debugging tool for DirectFB that shows a list
of surfaces and windows.</para></sect3>
                                                                               
<sect3><title>dfbg</title>
<para><command>dfbg</command> is a background configuration
tool.</para></sect3>
                                                                               
<sect3><title>dfbinfo</title>
<para>This tool enumerates input devices.</para></sect3>
                                                                               
<sect3><title>dfblayer</title>
<para><command>dfblayer</command> is a display layer configuration
tool.</para></sect3>
                                                                               
<sect3><title>directfb-config</title>
<para><command>directfb-config</command> provides all flags to link static binaries with
selectable drivers and other modules built in.</para></sect3>
                                                                               
<sect3><title>directfb-csource</title>
<para>This is a C code generation utility for DirectFB
surfaces.</para></sect3>
                                                                               
<sect3><title>libdirectfb libraries</title>
<para>They provide hardware graphics acceleration, input device handling
and abstraction, integrated windowing system with support for
translucent windows and multiple display layers on top of the Linux
frame buffer device.</para></sect3>
                                                                               
</sect2>

</sect1>