source: general/graphlib/colord.xml@ 41067694

<?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        "38f04d3882826d403f03a971bb54148a">
  <!ENTITY colord-size          "472 KB">
  <!ENTITY colord-buildsize     "16 MB">
  <!ENTITY colord-time          "0.2 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>The <application>colord</application> package is a system activated
    daemon that maps devices to color profiles. It is used by
    gnome-color-manager for system integration and use when there are no users
    logged in.</para>

    &lfs70_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="dbus"/>,
      <xref linkend="lcms2"/>,
      <xref linkend="sqlite"/> and
      <xref linkend="udev"/>
    </para>

    <bridgehead renderas="sect4">Recommended (Required if building GNOME)</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="polkit"/>
    </para>

    <bridgehead renderas="sect4">optional</bridgehead>
    <para role="optional">
      <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>Install <application>colord</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=/etc \
            --libexecdir=/usr/lib/colord \
            --localstatedir=/var \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

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

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

  </sect2>

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

    <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 Librariy</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          cd-create-profile, cd-fix-profile, colord, 
          colord-sane and colormgr
        </seg>
        <seg>
          libcolord.so
        </seg>
        <seg>
          /usr/include/colord-1, /usr/lib/colord,
          /usr/lib/colord-sensors, /usr/share/color,
          /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 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="colord-prog">
        <term><command>colord</command></term>
        <listitem>
          <para>is the color daemon.</para>
          <indexterm zone="colord colord-prog">
            <primary sortas="b-colord-prog">colord-prog</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>