source: general/sysutils/colord.xml@ f865648

<?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 colord-download-http
           "http://www.freedesktop.org/software/colord/releases/colord-&colord-version;.tar.xz">
  <!ENTITY colord-download-ftp  " ">
  <!ENTITY colord-md5sum        "9bd8a1f117742c31d195a09092ca3066">
  <!ENTITY colord-size          "1.1 MB">
  <!ENTITY colord-buildsize     "30 MB (additional 3 MB to rebuild and install
                                 the API documentation, and 3 MB for the tests)">
  <!ENTITY colord-time          "0.4 SBU">
]>

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

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

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

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

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

    <para>
      <application>Colord</application> is a system activated daemon that
      maps devices to color profiles. It is used by
      <application>GNOME Color Manager</application> for system integration
      and use when there are no users logged in.
    </para>

    &lfs74_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/>,
      <xref linkend="intltool"/>,
      <xref linkend="lcms2"/>,
      <xref linkend="sqlite"/>, and
      <xref linkend="dbus"/>
    </para>

    <bridgehead renderas="sect4">Required (for the tests)</bridgehead>
    <para role="required">
      <ulink url="http://www.valgrind.org/">Valgrind</ulink>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libgusb"/>,
      <xref linkend="udev-extras"/> (for GUdev),
      <xref linkend="polkit"/>,
      <xref linkend="gobject-introspection"/>, and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="bash-completion.alioth.debian.org">Bash Completion</ulink>,
      <ulink url="http://www.freedesktop.org/software/colord/releases/">
      colord-gtk</ulink> and <xref linkend="gnome-desktop"/>
      (To build the example tools),
      <xref linkend="docbook-utils"/>,
      <xref linkend="gtk-doc"/> and
      <xref linkend="sane"/>
    </para>

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

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

    <para>
      There should be a dedicated user and group to take control
      of the <command>colord</command> daemon after it is started.
      Issue the following commands as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>groupadd -g 71 colord &amp;&amp;
useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
        -g colord -s /bin/false colord</userinput></screen>

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

<screen><userinput>./configure --prefix=/usr                \
            --sysconfdir=/etc            \
            --localstatedir=/var         \
            --libexecdir=/usr/lib/colord \
            --with-daemon-user=colord    \
            --enable-vala                \
            --disable-bash-completion    \
            --disable-systemd-login      \
            --disable-static &amp;&amp;
make</userinput></screen>

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

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

    <para>
      To test the results, issue: <command>make -k check</command>. For unknown
      reasons, one test (cd-self-test) fails. Note that system-wide
      <application>D-Bus</application> daemon must be running or the tests will
      fail.
    </para>

  </sect2>

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

    <para>
      <parameter>--with-daemon-user=colord</parameter>: This
      switch is used so the <command>colord</command> daemon
      will run as an unprivileged user instead of
      <systemitem class="username">root</systemitem> user.
    </para>

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

    <para>
      <parameter>--disable-bash-completion</parameter>: This switch
      disables <application>Bash Completion</application>
      support for <application>Colord</application> apps.
    </para>

    <para>
      <parameter>--disable-systemd-login</parameter>: This switch
      prevents <command>configure</command> to look for
      <application>Systemd</application> libraries since
      <application>Systemd</application> is not part of
      LFS or BLFS.
    </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"/>

    <para>
      <option>--disable-gusb</option>: Use this switch if you don't have
      <application>libgusb</application> installed.
    </para>

    <para>
      <option>--disable-gudev</option>: Use this switch if you don't have GUdev
      installed.
    </para>

    <para>
      <option>--disable-polkit</option>: Use this switch if you don't have
      <application>Polkit</application> installed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          cd-create-profile, cd-fix-profile, cd-iccdump, colord,
          colord-sane, colord-session, and colormgr
        </seg>
        <seg>
          libcolordprivate.so, libcolord.so, libcolorhug.so and
          several under /usr/lib/colord-plugin
        </seg>
        <seg>
          /usr/include/colord-1,
          /usr/lib/colord,
          /usr/lib/colord-plugins,
          /usr/lib/colord-sensors,
          /usr/share/color,
          /usr/share/colord,
          /usr/share/gtk-doc/html/colord and
          /var/lib/colord
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="cd-create-profile">
        <term><command>cd-create-profile</command></term>
        <listitem>
          <para>
            is a Color Manager Profile Creation Tool.
          </para>
          <indexterm zone="colord cd-create-profile">
            <primary sortas="b-cd-create-profile">cd-create-profile</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cd-fix-profile">
        <term><command>cd-fix-profile</command></term>
        <listitem>
          <para>
            is a tool used to fix metadata in ICC profiles.
          </para>
          <indexterm zone="colord cd-fix-profile">
            <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="colormgr">
        <term><command>colormgr</command></term>
        <listitem>
          <para>
            is a text-mode program that allows you to interact with colord
            on the command line.
          </para>
          <indexterm zone="colord colormgr">
            <primary sortas="b-colormgr">colormgr</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>