source: x/lib/colord-gtk.xml@ 743d191a

<?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 colord-gtk-download-http "https://www.freedesktop.org/software/colord/releases/colord-gtk-&colord-gtk-version;.tar.xz">
  <!ENTITY colord-gtk-download-ftp  " ">
  <!ENTITY colord-gtk-md5sum        "d436740c06e42af421384f16b2a9a0a7">
  <!ENTITY colord-gtk-size          "24 KB">
  <!ENTITY colord-gtk-buildsize     "2.1 MB">
  <!ENTITY colord-gtk-time          "less than 0.1 SBU">
]>

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


  <title>colord-gtk-&colord-gtk-version;</title>

  <indexterm zone="colord-gtk">
    <primary sortas="a-colord-gtk">colord-gtk</primary>
  </indexterm>

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

    <para>
      The <application>Colord GTK</application> package contains
      <application>GTK+</application> bindings for
      <application>Colord</application>.
    </para>

    &lfs121_checked;

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

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk4"/>, and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="docbook-utils"/> and
      <xref linkend="gtk-doc"/>
    </para>

  </sect2>

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

    <warning>
      <para>
        If building the documentation <command>ninja -j1</command> must be used.
      </para>
    </warning>

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

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

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk4=true         \
            -Dvapi=true         \
            -Ddocs=false        \
            -Dman=false         \
            ..                  &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
      The tests need to be run from an X session, and may require
      a color profile for your primary display.
      <!-- on an ASUS 32" IPS display, I have a color profile and it works
           properly. On the other hand, with a Dell SP2208WFP LCD,
           no color profile is available and the tests fail. It seems to
           depend on the system/display. -->
    </para>

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

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

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para>
      <parameter>-Dvapi=true</parameter>: This switch enables
      building of the Vala bindings. Remove this switch if you don't
      have <xref linkend="vala" role="nodep"/> installed.
    </para>

    <para>
      <parameter>-Dgtk4=true</parameter>: This switch enables building
      the GTK-4 bindings for colord. Set this option to 'false' if you
      do not have <xref linkend="gtk4" role="nodep"/> installed.
    </para>

    <para>
      <parameter>-Ddocs=false</parameter>: This switch disables building
      gtk-doc based documentation. Even if gtk-doc is installed, you will
      need the namespaced versions of the Docbook XSL stylesheets.
    </para>

    <para>
      <parameter>-Dman=false</parameter>: This switch disables generating
      the manual pages for this package. Remove this switch if you have
      namespaced versions of the Docbook XSL stylesheets installed.
    </para>

    <para>
      <option>-Dgtk2=true</option>: This switch enables building
      the GTK+-2 bindings for colord. However since gtk2 is deprecated 
      it is not recommended to build these bindings.
    </para>

    <!--
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>
    -->
  </sect2>

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

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

      <seglistitem>
        <seg>
          cd-convert
        </seg>
        <seg>
          libcolord-gtk.so, and
          libcolord-gtk4.so
        </seg>
        <seg>
          /usr/include/colord-1/colord-gtk and
          /usr/share/gtk-doc/html/colord-gtk
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="cd-convert">
        <term><command>cd-convert</command></term>
        <listitem>
          <para>
            is a Color Manager Testing Tool
          </para>
          <indexterm zone="colord-gtk cd-convert">
            <primary sortas="b-cd-convert">cd-convert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcolord-gtk">
        <term><filename class="libraryfile">libcolord-gtk.so</filename></term>
        <listitem>
          <para>
            contains the <application>Colord</application>
            <application>GTK+</application> bindings
          </para>
          <indexterm zone="colord-gtk libcolord-gtk">
            <primary sortas="c-libcolord-gtk">libcolord-gtk.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcolord-gtk4">
        <term><filename class="libraryfile">libcolord-gtk4.so</filename></term>
        <listitem>
          <para>
            contains the <application>Colord</application>
            <application>GTK-4</application> bindings
          </para>
          <indexterm zone="colord-gtk libcolord-gtk4">
            <primary sortas="c-libcolord-gtk4">libcolord-gtk4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>