source: x/lib/fltk.xml@ 4c24eb0a

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!-- Watch directory when updating -->
  <!ENTITY fltk-download-http "http://fltk.org/pub/fltk/1.3.5/fltk-&fltk-version;-source.tar.gz">
  <!ENTITY fltk-download-ftp  " ">
  <!ENTITY fltk-md5sum        "e85017defd5a03ae82e634311db87bbf">
  <!ENTITY fltk-size          "5.1 MB">
  <!ENTITY fltk-buildsize     "117 MB (with documentation)">
  <!ENTITY fltk-time          "0.2 SBU (Using parallelism=4)">
]>

<sect1 id="fltk" xreflabel="FLTK-&fltk-version;">
  <?dbhtml filename="fltk.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>FLTK-&fltk-version;</title>

  <indexterm zone="fltk">
    <primary sortas="a-FLTK">FLTK</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to FLTK</title>

    <para>
      FLTK (pronounced "fulltick") is a cross-platform C++ GUI toolkit.
      FLTK provides modern GUI functionality and supports 3D graphics via
      OpenGL and its built-in GLUT emulation libraries used for creating
      graphical user interfaces for applications.
    </para>

    &lfs10_checked;

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

    <bridgehead renderas="sect3">FLTK Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="hicolor-icon-theme"/>,
      <xref linkend="libjpeg"/>, and
      <xref linkend="libpng"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="alsa-lib"/>,
      <xref linkend="desktop-file-utils"/>,
      <xref linkend="doxygen"/>,
      <xref linkend="glu"/>,
      <xref linkend="mesa"/>, and
      <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/fltk"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of FLTK</title>

    <note>
      <para>
        The tar extraction directory is fltk-&fltk-version; and not
        fltk-&fltk-version;-source as indicated by the tarball name.
      </para>
    </note>

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

<screen><userinput>sed -i -e '/cat./d' documentation/Makefile       &amp;&amp;

./configure --prefix=/usr    \
            --enable-shared  &amp;&amp;
make</userinput></screen>

    <para>
      If you wish to create the API documentation, issue:
    </para>

<screen remap="doc"><userinput>make -C documentation html</userinput></screen>

    <para>
      The tests for the package are interactive.  To execute the tests, run
      <command>test/unittests</command>. In addition, there are 70 other
      executable test programs in the <filename
      class='directory'>test</filename> directory that can be run individually.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make docdir=/usr/share/doc/fltk-&fltk-version; install</userinput></screen>

    <para>
      If desired, install some example games built as a part of the tests,
      extra documentation and example programs.  As the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"
        remap="doc"><userinput>make -C test          docdir=/usr/share/doc/fltk-&fltk-version; install-linux &amp;&amp;
make -C documentation docdir=/usr/share/doc/fltk-&fltk-version; install-linux</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sed ... documentation/Makefile</command>: Avoid installing
      pages in <filename class='directory'>/usr/share/man/cat*</filename>.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          blocks,
          checkers,
          fltk-config,
          fluid, and
          sudoku
        </seg>
        <seg>
          libfltk.{a,so},
          libfltk_forms.{a,so},
          libfltk_gl.{a,so}, and
          libfltk_images.{a,so}
        </seg>
        <seg>
          /usr/include/FL and
          /usr/share/doc/fltk-&fltk-version;
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

     <varlistentry id="blocks">
        <term><command>blocks</command></term>
        <listitem>
          <para>
            is a FLTK-based block elimination game
          </para>
          <indexterm zone="fltk blocks">
            <primary sortas="b-blocks">blocks</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="checkers">
        <term><command>checkers</command></term>
        <listitem>
          <para>
            is a FLTK-based version of the game of checkers
          </para>
          <indexterm zone="fltk checkers">
            <primary sortas="b-checkers">checkers</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fltk-config">
        <term><command>fltk-config</command></term>
        <listitem>
          <para>
            is a utility script that can be used to get information about the
            current version  of  FLTK that is installed on the system
          </para>
          <indexterm zone="fltk fltk-config">
            <primary sortas="b-fltk-config">fltk-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fluid">
        <term><command>fluid</command></term>
        <listitem>
          <para>
            is an interactive GUI designer for FLTK
          </para>
          <indexterm zone="fltk fluid">
            <primary sortas="b-fluid">fluid</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="sudoku">
        <term><command>sudoku</command></term>
        <listitem>
          <para>
            is an implementation of the popular Sudoku game
          </para>
          <indexterm zone="fltk sudoku">
            <primary sortas="b-sudoku">sudoku</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfltk">
        <term><filename class="libraryfile">libfltk.so</filename></term>
        <listitem>
          <para>
            contains functions that provide an API to implement graphical user
            interfaces
          </para>
          <indexterm zone="fltk libfltk">
            <primary sortas="c-libfltk">libfltk.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>