glfs/general/sysutils/colord.xml
Bruce Dubbs ad112fd598 Update to cups-2.2.12.
Update to node.js-10.16.3. 
Update to gtk-doc-1.32. 
Tag qt5 and its dependencies.



git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21996 af4574ff-66df-0310-9fd7-8a98e5e911e0
2019-08-18 20:33:32 +00:00

394 lines
12 KiB
XML

<?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 "https://www.freedesktop.org/software/colord/releases/colord-&colord-version;.tar.xz">
<!ENTITY colord-download-ftp " ">
<!ENTITY colord-md5sum "32c2709a6002d9ee750483aaed6379c8">
<!ENTITY colord-size "1.8 MB">
<!ENTITY colord-buildsize "23 MB (with tests)">
<!ENTITY colord-time "0.1 SBU (with tests)">
]>
<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 service that makes it easy
to manage, install, and generate color profiles. It is used mainly by
<application>GNOME Color Manager</application> for system integration
and use when no users are logged in.
</para>
&lfs90_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="glib2"/>,
<xref linkend="lcms2"/>,
<xref linkend="polkit"/>, and
<!-- Polkit now needed, see #11481 in Trac -->
<xref linkend="sqlite"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="gobject-introspection"/>,
<xref linkend="libgudev"/>,
<xref linkend="libgusb"/>,
<phrase revision="sysv">and</phrase>
<phrase revision="systemd"><xref linkend="systemd"/>, and</phrase>
<xref linkend="vala"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="gnome-desktop"/> and
<xref linkend="colord-gtk"/> (to build the example tools),
<xref linkend="libxslt"/>,
<xref linkend="sane"/>,
<ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink>, and
<ulink url="https://github.com/scop/bash-completion/">Bash Completion</ulink>
</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 colord
daemon after it has 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>First, clean up about 100 warnings:</para>
<screen><userinput>mv po/fur.po po/ur.po &amp;&amp;
sed -i 's/fur/ur/' po/LINGUAS</userinput></screen>
<para>
Install <application>Colord</application> by running the following
commands:
</para>
<screen revision="sysv"><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
meson --prefix=/usr \
--sysconfdir=/etc \
--localstatedir=/var \
-Ddaemon_user=colord \
-Dvapi=true \
-Dsystemd=false \
-Dlibcolordcompat=true \
-Dargyllcms_sensor=false \
-Dbash_completion=false \
-Ddocs=false \
-Dman=false .. &amp;&amp;
ninja</userinput></screen>
<screen revision="systemd"><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
meson --prefix=/usr \
--sysconfdir=/etc \
--localstatedir=/var \
-Ddaemon_user=colord \
-Dvapi=true \
-Dsystemd=true \
-Dlibcolordcompat=true \
-Dargyllcms_sensor=false \
-Dbash_completion=false \
-Ddocs=false \
-Dman=false .. &amp;&amp;
ninja</userinput></screen>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>ninja install</userinput></screen>
<para>
To test the results, issue: <command>ninja -k 2 test</command>.
One test, <filename>colord-self-test-daemon</filename>, will fail.
The test suite must be run after the package is installed, and the
system-wide D-Bus Daemon must be running.
</para>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<parameter>-Ddaemon_user=colord</parameter>: This switch is used
so the colord daemon will run as an unprivileged user instead of the
<systemitem class="username">root</systemitem> user.
</para>
<para>
<parameter>-Dvapi=true</parameter>: This switch enables building
the <application>Vala</application> bindings. Remove if you don't have
<xref linkend="vala"/> installed.
</para>
<para revision="sysv">
<parameter>-Dsystemd=false</parameter>: This switch disables
support for <application>systemd</application> login in Colord
applications.
</para>
<para revision="systemd">
<parameter>-Dsystemd=true</parameter>: This switch enables
installation of the <application>systemd</application> service.
</para>
<para>
<parameter>-Dlibcolordcompat=true</parameter>: This switch enables
building a compatibility library for older packages that use
<application>Colord</application>.
</para>
<para>
<parameter>-Dargyllcms_sensor=false</parameter>: This switch
disables the ArgLLCMS sensor driver. Omit if you have
<ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
and wish to use it.
</para>
<para>
<parameter>-Dbash_completion=false</parameter>: This switch
disables Bash Completion support for Colord applications.
</para>
<para>
<parameter>-Ddocs=false</parameter>: This switch disables building
of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
</para>
<para>
<parameter>-Dman=false</parameter>: This switch disables building
of man pages. Omit if you have <xref linkend="docbook-utils"/>
available. Namespaced versions of the docbook-xsl stylesheets
are also required.
</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,
cd-it8, and
colormgr
</seg>
<seg>
libcolord.so,
libcolordcompat.so,
libcolordprivate.so, and
libcolorhug.so
</seg>
<seg>
/usr/include/colord-1,
/usr/lib/colord-{plugins,sensors},
/usr/share/color{d},
/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"?>
<!-- If the program or library name conflicts (is the same) as the
package name, add -prog or -lib to the varlistentry entity id
and the 2nd entry of the indexterm zone entity -->
<varlistentry id="cd-create-profile">
<term><command>cd-create-profile</command></term>
<listitem>
<para>
is the 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="cd-iccdump">
<term><command>cd-iccdump</command></term>
<listitem>
<para>
dumps the contents of an ICC profile as human readable text.
</para>
<indexterm zone="colord cd-iccdump">
<primary sortas="b-cd-iccdump">cd-iccdump</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="cd-it8">
<term><command>cd-it8</command></term>
<listitem>
<para>
is the Color Manager Testing Tool.
</para>
<indexterm zone="colord cd-it8">
<primary sortas="b-cd-it8">cd-it8</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.so">
<term><filename class="libraryfile">libcolord.so</filename></term>
<listitem>
<para>
contains the <application>Colord</application> API functions.
</para>
<indexterm zone="colord libcolord.so">
<primary sortas="c-libcolord.so">libcolord.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libcolordcompat.so">
<term><filename class="libraryfile">libcolordcompat.so</filename></term>
<listitem>
<para>
contains legacy API functions for compatibility with older
applications.
</para>
<indexterm zone="colord libcolordcompat.so">
<primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libcolordprivate.so">
<term><filename class="libraryfile">libcolordprivate.so</filename></term>
<listitem>
<para>
contains internal API functions for the programs included with
<application>Colord</application>.
</para>
<indexterm zone="colord libcolordprivate.so">
<primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libcolorhug.so">
<term><filename class="libraryfile">libcolorhug.so</filename></term>
<listitem>
<para>
contains a simple display hardware colorimiter.
</para>
<indexterm zone="colord libcolorhug.so">
<primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>