source: x/lib/gtk+2.xml@ de53c9be

<?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;

  <!ENTITY gtk2-download-http "&gnome-download-http;/gtk+/2.20/gtk+-&gtk2-version;.tar.bz2">
  <!ENTITY gtk2-download-ftp  "ftp://ftp.gtk.org/pub/gtk/2.20/gtk+-&gtk2-version;.tar.bz2">
  <!ENTITY gtk2-md5sum        "53e6f3a93bd22934878fc4a4a34c68aa">
  <!ENTITY gtk2-size          "18.2 MB">
  <!ENTITY gtk2-buildsize     "331 MB">
  <!ENTITY gtk2-time          "7.0 SBU">
]>

<sect1 id="gtk2" xreflabel="GTK+-&gtk2-version;">
  <?dbhtml filename="gtk2.html" ?>

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

  <title>GTK+-&gtk2-version;</title>

  <indexterm zone="gtk2">
    <primary sortas="a-GTK2">GTK2</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GTK+</title>

    <para>The <application>GTK+</application> package contains
    <application>GTK+</application> libraries. These are useful
    for creating graphical user interfaces for applications.</para>

    &lfs65_checked;

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

    <bridgehead renderas="sect3">GTK+ Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="cairo"/>,
    <xref linkend="pango"/>, and
    <xref linkend="atk"/></para>

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

    <!-- hicolor-icon-theme is required for the test suite -->

    <para>Though not required, the <application>GTK+</application> developers
    expect <application>libtiff</application>, and
    <application>libjpeg</application> to be installed. Other packages also
    expect <application>GTK+</application>-2 to be built with support for these
    graphics packages as well.</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="cups"/>,
    <xref linkend="jasper"/>,
    <xref linkend="docbook-utils"/>,
    <ulink url="http://beagle-project.org/Main_Page">libbeagle</ulink>,
    <xref linkend="gobject-introspection"/>,
    <xref linkend="gtk-doc"/>, and
    <ulink url="http://www.tracker-project.org/">Tracker</ulink></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of GTK+</title>

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>. Note that
    you must run the tests from a session with X Window Display capability
    (i.e., not a text-based terminal/console) as the tests attempt to open an X
    window, and the tests can take an excessively long time. Using an X Window,
    the tests should take less than .3 SBUs</para>

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

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/gtk+-&gtk2-version;/{faq,tutorial} &amp;&amp;
cp -v -R docs/faq/html/* /usr/share/doc/gtk+-&gtk2-version;/faq &amp;&amp;
cp -v -R docs/tutorial/html/* /usr/share/doc/gtk+-&gtk2-version;/tutorial &amp;&amp;
install -v -m644 docs/*.txt /usr/share/doc/gtk+-&gtk2-version;</userinput></screen>

    <warning>
      <para>If you installed the package on to your system using a
      <quote>DESTDIR</quote> method, important files were not installed and
      must be copied and/or generated. First generate two files using the
      following commands as the <systemitem class="username">root</systemitem>
      user:</para>

<screen role="root"><userinput>gdk-pixbuf-query-loaders >/etc/gtk-2.0/gdk-pixbuf.loaders &amp;&amp;
gtk-query-immodules-2.0  >/etc/gtk-2.0/gtk.immodules</userinput></screen>

    <para>There is a bug in the <filename>Makefile</filename> that skips the
    installation of the <filename class="extension">.1</filename> man files.
    Install them using the following commands as the
    <systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>install -m644 -v gdk-pixbuf/gdk-pixbuf-csource.1                      \
                 docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.1 \
                 docs/reference/gtk/gtk-builder-convert.1             \
                 docs/reference/gtk/gtk-query-immodules-2.0.1         \
                 docs/reference/gtk/gtk-update-icon-cache.1           \
                 /usr/share/man/man1</userinput></screen>
    </warning>

  </sect2>

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

    <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
    configuration files into <filename class="directory">/etc</filename>
    instead of <filename class="directory">/usr/etc</filename>.</para>

    <para><option>--enable-gtk-doc</option>: This switch will rebuild
    the API documentation during the <command>make</command> command. Ensure
    you really want to rebuild this documentation (and end up with what is
    already shipped in the source tree) as it takes a very long time.</para>

    <para><option>--without-libtiff</option>: Use this switch if you
    don't have <application>libtiff</application> installed.</para>

    <para><option>--without-libjpeg</option>: Use this switch if you
    don't have <application>libjpeg</application> installed.</para>

    <para><option>--with-libjasper</option>: Use this option if you
    have <application>libjasper</application> installed.</para>

    <para><parameter>--disable-static</parameter>: This switch prevents the
    static libraries from being built.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gdk-pixbuf-csource, gdk-pixbuf-query-loaders, gtk-builder-convert,
        gtk-demo, gtk-query-immodules-2.0, and gtk-update-icon-cache</seg>
        <seg>libpixmap.so, im-am-et.so, im-cedilla.so, im-cyrillic-translit.so,
        im-inuktitut.so, im-ipa.so, im-multipress.so, im-thai.so, im-ti-er.so,
        im-ti-et.so, im-viqr.so, im-xim.so, libpixbufloader-ani.so,
        libpixbufloader-bmp.so, libpixbufloader-gif.so, libpixbufloader-icns.so,
        libpixbufloader-ico.so, libpixbufloader-jpeg.so, libpixbufloader-pcx.so,
        libpixbufloader-png.so, libpixbufloader-pnm.so, libpixbufloader-qtif.so,
        libpixbufloader-ras.so, libpixbufloader-tga.so, libpixbufloader-tiff.so,
        libpixbufloader-wbmp.so, libpixbufloader-xbm.so, libpixbufloader-xpm.so,
        libprintbackend-file.so, libprintbackend-lpr.so,
        libferret.so, libgail.so, libgailutil.so, libgdk-x11-2.0.so,
        libgdk_pixbuf-2.0.so, libgdk_pixbuf_xlib-2.0.so, and
        libgtk-x11-2.0.so</seg>
        <seg>/etc/gtk-2.0, /usr/{include/{gail-1.0/{gail,libgail-util},
        gtk-2.0/{gdk-pixbuf-xlib,gtk},gtk-unix-print-2.0/gtk},
        lib/gtk-2.0/{2.10.0/{engines,immodules,loaders,printbackends},include,
        modules},share/{doc/gtk+-&gtk2-version;/{faq/stylesheet-images,
        tutorial/{images,stylesheet-images}},gtk-2.0/demo,
        gtk-doc/html/{gail-libgail-util,gdk-pixbuf,gtk},
        themes/{Default/gtk-2.0-key,Emacs/gtk-2.0-key,Raleigh/gtk-2.0}}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gdk-pixbuf-csource">
        <term><command>gdk-pixbuf-csource</command></term>
        <listitem>
          <para>generates C code containing images, useful for compiling
          images directly into programs.</para>
          <indexterm zone="gtk2 gdk-pixbuf-csource">
            <primary sortas="b-gdk-pixbuf-csource">gdk-pixbuf-csource</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gdk-pixbuf-query-loaders">
        <term><command>gdk-pixbuf-query-loaders</command></term>
        <listitem>
          <para>collects information about loadable modules for gdk-pixbuf
          and writes it to standard output.</para>
          <indexterm zone="gtk2 gdk-pixbuf-query-loaders">
            <primary
            sortas="b-gdk-pixbuf-query-loaders">gdk-pixbuf-query-loaders</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gtk-builder-convert">
        <term><command>gtk-builder-convert</command></term>
        <listitem>
          <para>converts glade files into XML files which can be loaded with
          GtkBuilder.</para>
          <indexterm zone="gtk2 gtk-builder-convert">
            <primary
            sortas="b-gtk-builder-convert">gtk-builder-convert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gtk-demo">
        <term><command>gtk-demo</command></term>
        <listitem>
          <para>demonstrates <application>GTK+</application> functionality and
          provides code for the examples.</para>
          <indexterm zone="gtk2 gtk-demo">
            <primary
            sortas="b-gtk-demo">gtk-demo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gtk-query-immodules-2.0">
        <term><command>gtk-query-immodules-2.0</command></term>
        <listitem>
          <para>collects information about loadable input method modules for
          <application>GTK+</application> and writes it to standard output.</para>
          <indexterm zone="gtk2 gtk-query-immodules-2.0">
            <primary
            sortas="b-gtk-query-immodules-2.0">gtk-query-immodules-2.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gtk-update-icon-cache">
        <term><command>gtk-update-icon-cache</command></term>
        <listitem>
          <para>creates mmap()able cache files for icon themes.</para>
          <indexterm zone="gtk2 gtk-update-icon-cache">
            <primary sortas="b-gtk-update-icon-cache">gtk-update-icon-cache</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="GTK2libs">
        <term>GTK+ Libraries</term>
        <listitem>
          <para>provide an API to implement graphical user interfaces.</para>
          <indexterm zone="gtk2 GTK2libs">
            <primary sortas="c-GTK2libs">GTK+ Libraries</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>