source: x/lib/gtkmm3.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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 gtkmm3-download-http "&gnome-download-http;/gtkmm/&gnome-minor-24;/gtkmm-&gtkmm3-version;.tar.xz">
  <!ENTITY gtkmm3-download-ftp  " ">
  <!ENTITY gtkmm3-md5sum        "47871a7973e186c1189b2145b507de15">
  <!ENTITY gtkmm3-size          "14 MB">
  <!ENTITY gtkmm3-buildsize     "200 MB (with tests)">
  <!ENTITY gtkmm3-time          "1.2 SBU (Using parallelism=4; with tests)">
]>

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


  <title>Gtkmm-&gtkmm3-version;</title>

  <indexterm zone="gtkmm3">
    <primary sortas="a-Gtkmm">Gtkmm</primary>
  </indexterm>

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

    <para>
      The <application>Gtkmm</application> package provides a C++ interface to
      <application>GTK+ 3</application>.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="atkmm"/>,
      <xref linkend="gtk3"/>, and
      <xref linkend="pangomm"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>
    </para>

  </sect2>

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

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

<screen><userinput>mkdir gtkmm3-build &amp;&amp;
cd    gtkmm3-build &amp;&amp;

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>. Note that you
      must be in a graphical environment, as the tests try to open some
      windows.
    </para>

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

<screen role="root"><userinput>ninja install</userinput></screen>

    <para>
      If you have built the documentation (see Command Explanations below) it
      was installed to <filename
      class="directory">/usr/share/doc/gtkmm-3.0</filename>. For consistency,
      move it to a versioned directory as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="nodump"><userinput>mv -v /usr/share/doc/gtkmm-3.0 /usr/share/doc/gtkmm-&gtkmm3-version;</userinput></screen>

  </sect2>

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

    <para>
      <option>-Dbuild-documentation=true</option>: If you have installed
      <xref linkend="doxygen"/> this define will build and install the
      documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgdkmm-3.0.so and libgtkmm-3.0.so
        </seg>
        <seg>
          /usr/include/gdkmm-3.0,
          /usr/include/gtkmm-3.0,
          /usr/lib/gdkmm-3.0,
          /usr/lib/gtkmm-3.0, and optionally
          /usr/share/{devhelp/books/gtkmm-3.0,doc/gtkmm-&gtkmm3-version;}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgdkmm-3">
        <term><filename class="libraryfile">libgdkmm-3.0.so</filename></term>
        <listitem>
        <para>
          contains the GDK API classes
        </para>
          <indexterm zone="gtkmm3 libgdkmm-3">
            <primary sortas="c-libgdkmm-3">libgdkmm-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgtkmm-3">
        <term><filename class="libraryfile">libgtkmm-3.0.so</filename></term>
        <listitem>
        <para>
          contains the <application>GTK+ 3</application> API classes
        </para>
          <indexterm zone="gtkmm3 libgtkmm-3">
            <primary sortas="c-libgtkmm-3">libgtkmm-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>