source: general/sysutils/colord.xml@ bc761a0

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since bc761a0 was f858bd7, checked in by Bruce Dubbs <bdubbs@…>, 6 years ago

Update to webkitgtk-2.20.0.
Update to gtksourceview-3.24.7.
Update to libsoup-2.62.0.
Update to colord-1.4.2.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20022 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 12.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY colord-download-http "https://www.freedesktop.org/software/colord/releases/colord-&colord-version;.tar.xz">
8 <!ENTITY colord-download-ftp " ">
9 <!ENTITY colord-md5sum "eb6bcc5b826e1ad9bfa75c94534826a4">
10 <!ENTITY colord-size "1.8 MB">
11 <!ENTITY colord-buildsize "24 MB (with tests)">
12 <!ENTITY colord-time "0.2 SBU (with tests)">
13]>
14
15<sect1 id="colord" xreflabel="colord-&colord-version;">
16 <?dbhtml filename="colord.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Colord-&colord-version;</title>
24
25 <indexterm zone="colord">
26 <primary sortas="a-colord">Colord</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Colord</title>
31
32 <para>
33 <application>Colord</application> is a system service that makes it easy
34 to manage, install, and generate color profiles. It is used mainly by
35 <application>GNOME Color Manager</application> for system integration
36 and use when no users are logged in.
37 </para>
38
39 &lfs82_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&colord-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&colord-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &colord-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &colord-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &colord-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &colord-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Colord Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="dbus"/>,
80 <xref linkend="glib2"/>,
81 <xref linkend="lcms2"/>, and
82 <xref linkend="sqlite"/>
83 </para>
84
85 <bridgehead renderas="sect4">Recommended</bridgehead>
86 <para role="recommended">
87 <xref linkend="gobject-introspection"/>,
88 <xref linkend="libgudev"/>,
89 <xref linkend="libgusb"/>,
90 <xref linkend="polkit"/>, <phrase revision="sysv">and</phrase>
91 <phrase revision="systemd"><xref linkend="systemd"/>, and</phrase>
92 <xref linkend="vala"/>
93 </para>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 <xref linkend="docbook-utils"/>,
98 <xref linkend="gnome-desktop"/> and
99 <xref linkend="colord-gtk"/> (to build the example tools),
100 <xref linkend="gtk-doc"/>,
101 <xref linkend="libxslt"/>,
102 <xref linkend="sane"/>,
103 <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink>, and
104 <ulink url="https://github.com/scop/bash-completion/">Bash Completion</ulink>
105 </para>
106
107 <para condition="html" role="usernotes">
108 User Notes: <ulink url="&blfs-wiki;/colord"/>
109 </para>
110 </sect2>
111
112 <sect2 role="installation">
113 <title>Installation of Colord</title>
114
115 <para>
116 There should be a dedicated user and group to take control of the colord
117 daemon after it has started. Issue the following commands as the
118 <systemitem class="username">root</systemitem> user:
119 </para>
120
121<screen role="root"><userinput>groupadd -g 71 colord &amp;&amp;
122useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
123 -g colord -s /bin/false colord</userinput></screen>
124
125 <para>
126 Install <application>Colord</application> by running the following
127 commands:
128 </para>
129
130<screen revision="sysv"><userinput>mkdir build &amp;&amp;
131cd build &amp;&amp;
132
133meson --prefix=/usr \
134 --sysconfdir=/etc \
135 --localstatedir=/var \
136 -Dwith-daemon-user=colord \
137 -Denable-vala=true \
138 -Denable-systemd=false \
139 -Denable-libcolordcompat=true \
140 -Denable-argyllcms-sensor=false \
141 -Denable-bash-completion=false \
142 -Denable-docs=false \
143 -Denable-man=false .. &amp;&amp;
144ninja</userinput></screen>
145
146<screen revision="systemd"><userinput>mkdir build &amp;&amp;
147cd build &amp;&amp;
148meson --prefix=/usr \
149 --sysconfdir=/etc \
150 --localstatedir=/var \
151 -Dwith-daemon-user=colord \
152 -Denable-vala=true \
153 -Denable-systemd=true \
154 -Denable-libcolordcompat=true \
155 -Denable-argyllcms-sensor=false \
156 -Denable-bash-completion=false \
157 -Denable-docs=false \
158 -Denable-man=false .. &amp;&amp;
159ninja</userinput></screen>
160
161 <para>
162 Now, as the <systemitem class="username">root</systemitem> user:
163 </para>
164
165<screen role="root"><userinput>ninja install</userinput></screen>
166
167 <para>
168 To test the results, issue: <command>ninja -k 2 test</command>.
169 One test, <filename>colord-self-test-daemon</filename>, will fail.
170 The test suite must be run after the package is installed, and the
171 system-wide D-Bus Daemon must be running.
172 </para>
173
174 </sect2>
175
176 <sect2 role="commands">
177 <title>Command Explanations</title>
178
179 <para>
180 <parameter>-Dwith-daemon-user=colord</parameter>: This switch is used
181 so the colord daemon will run as an unprivileged user instead of the
182 <systemitem class="username">root</systemitem> user.
183 </para>
184
185 <para>
186 <parameter>-Denable-vala=true</parameter>: This switch enables building
187 the <application>Vala</application> bindings. Remove if you don't have
188 <xref linkend="vala"/> installed.
189 </para>
190
191 <para revision="sysv">
192 <parameter>-Denable-systemd=false</parameter>: This switch disables
193 support for <application>systemd</application> login in Colord
194 applications.
195 </para>
196
197 <para revision="systemd">
198 <parameter>-Denable-systemd=true</parameter>: This switch enables
199 installation of the <application>systemd</application> service.
200 </para>
201
202 <para>
203 <parameter>-Denable-libcolordcompat=true</parameter>: This switch enables
204 building a compatibility library for older packages that use
205 <application>Colord</application>.
206 </para>
207
208 <para>
209 <parameter>-Denable-argyllcms-sensor=false</parameter>: This switch
210 disables the ArgLLCMS sensor driver. Omit if you have
211 <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
212 and wish to use it.
213 </para>
214
215 <para>
216 <parameter>-Denable-bash-completion=false</parameter>: This switch
217 disables Bash Completion support for Colord applications.
218 </para>
219
220 <para>
221 <parameter>-Denable-docs=false</parameter>: This switch disables building
222 of documentation. Omit if you have <xref linkend="gtk-doc"/> avaialable.
223 </para>
224
225 <para>
226 <parameter>-Denable-man=false</parameter>: This switch disables building
227 of man pages. Omit if you have <xref linkend="docbook-utils"/>
228 avaialable.
229 </para>
230
231 </sect2>
232
233 <sect2 role="content">
234 <title>Contents</title>
235
236 <segmentedlist>
237 <segtitle>Installed Programs</segtitle>
238 <segtitle>Installed Libraries</segtitle>
239 <segtitle>Installed Directories</segtitle>
240
241 <seglistitem>
242 <seg>
243 cd-create-profile,
244 cd-fix-profile,
245 cd-iccdump,
246 cd-it8, and
247 colormgr
248 </seg>
249 <seg>
250 libcolord.so,
251 libcolordcompat.so,
252 libcolordprivate.so, and
253 libcolorhug.so
254 </seg>
255 <seg>
256 /usr/include/colord-1,
257 /usr/lib/colord-{plugins,sensors},
258 /usr/share/color{d},
259 /usr/share/gtk-doc/html/colord, and
260 /var/lib/colord
261 </seg>
262 </seglistitem>
263 </segmentedlist>
264
265 <variablelist>
266 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
267 <?dbfo list-presentation="list"?>
268 <?dbhtml list-presentation="table"?>
269
270 <!-- If the program or library name conflicts (is the same) as the
271 package name, add -prog or -lib to the varlistentry entity id
272 and the 2nd entry of the indexterm zone entity -->
273
274 <varlistentry id="cd-create-profile">
275 <term><command>cd-create-profile</command></term>
276 <listitem>
277 <para>
278 is the Color Manager Profile Creation Tool.
279 </para>
280 <indexterm zone="colord cd-create-profile">
281 <primary sortas="b-cd-create-profile">cd-create-profile</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="cd-fix-profile">
287 <term><command>cd-fix-profile</command></term>
288 <listitem>
289 <para>
290 is a tool used to fix metadata in ICC profiles.
291 </para>
292 <indexterm zone="colord cd-fix-profile">
293 <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="cd-iccdump">
299 <term><command>cd-iccdump</command></term>
300 <listitem>
301 <para>
302 dumps the contents of an ICC profile as human readable text.
303 </para>
304 <indexterm zone="colord cd-iccdump">
305 <primary sortas="b-cd-iccdump">cd-iccdump</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="cd-it8">
311 <term><command>cd-it8</command></term>
312 <listitem>
313 <para>
314 is the Color Manager Testing Tool.
315 </para>
316 <indexterm zone="colord cd-it8">
317 <primary sortas="b-cd-it8">cd-it8</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="colormgr">
323 <term><command>colormgr</command></term>
324 <listitem>
325 <para>
326 is a text-mode program that allows you to interact with colord on
327 the command line.
328 </para>
329 <indexterm zone="colord colormgr">
330 <primary sortas="b-colormgr">colormgr</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="libcolord.so">
336 <term><filename class="libraryfile">libcolord.so</filename></term>
337 <listitem>
338 <para>
339 contains the <application>Colord</application> API functions.
340 </para>
341 <indexterm zone="colord libcolord.so">
342 <primary sortas="c-libcolord.so">libcolord.so</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="libcolordcompat.so">
348 <term><filename class="libraryfile">libcolordcompat.so</filename></term>
349 <listitem>
350 <para>
351 contains legacy API functions for compatibility with older
352 applications.
353 </para>
354 <indexterm zone="colord libcolordcompat.so">
355 <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="libcolordprivate.so">
361 <term><filename class="libraryfile">libcolordprivate.so</filename></term>
362 <listitem>
363 <para>
364 contains internal API functions for the programs included with
365 <application>Colord</application>.
366 </para>
367 <indexterm zone="colord libcolordprivate.so">
368 <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="libcolorhug.so">
374 <term><filename class="libraryfile">libcolorhug.so</filename></term>
375 <listitem>
376 <para>
377 contains a simple display hardware colorimiter.
378 </para>
379 <indexterm zone="colord libcolorhug.so">
380 <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384 </variablelist>
385 </sect2>
386</sect1>
Note: See TracBrowser for help on using the repository browser.