source: general/sysutils/colord.xml@ 427b46a

11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt 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 427b46a was eef74ab, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Tags for postlfs, general libraries, and programming

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24259 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 12.1 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 "adc4501b54fb8667ee99f64cff87e12d">
10 <!ENTITY colord-size "1.8 MB">
11 <!ENTITY colord-buildsize "31 MB (with tests)">
12 <!ENTITY colord-time "0.3 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 &lfs101_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"/>,
82 <xref linkend="polkit"/>, and
83 <!-- Polkit now needed, see #11481 in Trac -->
84 <xref linkend="sqlite"/>
85 </para>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref linkend="gobject-introspection"/>,
90 <xref linkend="libgudev"/>,
91 <xref linkend="libgusb"/>,
92 <phrase revision="sysv">and</phrase>
93 <phrase revision="systemd"><xref linkend="systemd"/>, and</phrase>
94 <xref linkend="vala"/>
95 </para>
96
97 <bridgehead renderas="sect4">Optional</bridgehead>
98 <para role="optional">
99 <xref linkend="gnome-desktop"/> and
100 <xref linkend="colord-gtk"/> (to build the example tools),
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 First, clean up about 100 warnings:
127 </para>
128
129<screen><userinput>mv po/fur.po po/ur.po &amp;&amp;
130sed -i 's/fur/ur/' po/LINGUAS</userinput></screen>
131
132 <para>
133 Install <application>Colord</application> by running the following
134 commands:
135 </para>
136
137<screen revision="sysv"><userinput>mkdir build &amp;&amp;
138cd build &amp;&amp;
139
140meson --prefix=/usr \
141 -Ddaemon_user=colord \
142 -Dvapi=true \
143 -Dsystemd=false \
144 -Dlibcolordcompat=true \
145 -Dargyllcms_sensor=false \
146 -Dbash_completion=false \
147 -Ddocs=false \
148 -Dman=false .. &amp;&amp;
149ninja</userinput></screen>
150
151<screen revision="systemd"><userinput>mkdir build &amp;&amp;
152cd build &amp;&amp;
153
154meson --prefix=/usr \
155 -Ddaemon_user=colord \
156 -Dvapi=true \
157 -Dsystemd=true \
158 -Dlibcolordcompat=true \
159 -Dargyllcms_sensor=false \
160 -Dbash_completion=false \
161 -Ddocs=false \
162 -Dman=false .. &amp;&amp;
163ninja</userinput></screen>
164
165 <para>
166 Now, as the <systemitem class="username">root</systemitem> user:
167 </para>
168
169<screen role="root"><userinput>ninja install</userinput></screen>
170
171 <para>
172 To test the results, issue: <command>ninja -k 2 test</command>.
173 One test, <filename>colord-self-test-daemon</filename>, will fail.
174 The test suite must be run after the package is installed, and the
175 system-wide D-Bus Daemon must be running.
176 </para>
177
178 </sect2>
179
180 <sect2 role="commands">
181 <title>Command Explanations</title>
182
183 <para>
184 <parameter>-Ddaemon_user=colord</parameter>: This switch is used
185 so the colord daemon will run as an unprivileged user instead of the
186 <systemitem class="username">root</systemitem> user.
187 </para>
188
189 <para>
190 <parameter>-Dvapi=true</parameter>: This switch enables building
191 the <application>Vala</application> bindings. Remove if you don't have
192 <xref linkend="vala"/> installed.
193 </para>
194
195 <para revision="sysv">
196 <parameter>-Dsystemd=false</parameter>: This switch disables
197 support for <application>systemd</application> login in Colord
198 applications.
199 </para>
200
201 <para revision="systemd">
202 <parameter>-Dsystemd=true</parameter>: This switch enables
203 installation of the <application>systemd</application> service.
204 </para>
205
206 <para>
207 <parameter>-Dlibcolordcompat=true</parameter>: This switch enables
208 building a compatibility library for older packages that use
209 <application>Colord</application>.
210 </para>
211
212 <para>
213 <parameter>-Dargyllcms_sensor=false</parameter>: This switch
214 disables the ArgLLCMS sensor driver. Omit if you have
215 <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
216 and wish to use it.
217 </para>
218
219 <para>
220 <parameter>-Dbash_completion=false</parameter>: This switch
221 disables Bash Completion support for Colord applications.
222 </para>
223
224 <para>
225 <parameter>-Ddocs=false</parameter>: This switch disables building
226 of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
227 </para>
228
229 <para>
230 <parameter>-Dman=false</parameter>: This switch disables building
231 of man pages. Omit if you have <xref linkend="docbook-utils"/>
232 available. Namespaced versions of the docbook-xsl stylesheets
233 are also required.
234 </para>
235
236 </sect2>
237
238 <sect2 role="content">
239 <title>Contents</title>
240
241 <segmentedlist>
242 <segtitle>Installed Programs</segtitle>
243 <segtitle>Installed Libraries</segtitle>
244 <segtitle>Installed Directories</segtitle>
245
246 <seglistitem>
247 <seg>
248 cd-create-profile,
249 cd-fix-profile,
250 cd-iccdump,
251 cd-it8, and
252 colormgr
253 </seg>
254 <seg>
255 libcolord.so,
256 libcolordcompat.so,
257 libcolordprivate.so, and
258 libcolorhug.so
259 </seg>
260 <seg>
261 /usr/include/colord-1,
262 /usr/lib/colord-{plugins,sensors},
263 /usr/share/color{d},
264 /usr/share/gtk-doc/html/colord, and
265 /var/lib/colord
266 </seg>
267 </seglistitem>
268 </segmentedlist>
269
270 <variablelist>
271 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
272 <?dbfo list-presentation="list"?>
273 <?dbhtml list-presentation="table"?>
274
275 <!-- If the program or library name conflicts (is the same) as the
276 package name, add -prog or -lib to the varlistentry entity id
277 and the 2nd entry of the indexterm zone entity -->
278
279 <varlistentry id="cd-create-profile">
280 <term><command>cd-create-profile</command></term>
281 <listitem>
282 <para>
283 is the Color Manager Profile Creation Tool
284 </para>
285 <indexterm zone="colord cd-create-profile">
286 <primary sortas="b-cd-create-profile">cd-create-profile</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="cd-fix-profile">
292 <term><command>cd-fix-profile</command></term>
293 <listitem>
294 <para>
295 is a tool used to fix metadata in ICC profiles
296 </para>
297 <indexterm zone="colord cd-fix-profile">
298 <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="cd-iccdump">
304 <term><command>cd-iccdump</command></term>
305 <listitem>
306 <para>
307 dumps the contents of an ICC profile as human readable text
308 </para>
309 <indexterm zone="colord cd-iccdump">
310 <primary sortas="b-cd-iccdump">cd-iccdump</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="cd-it8">
316 <term><command>cd-it8</command></term>
317 <listitem>
318 <para>
319 is the Color Manager Testing Tool
320 </para>
321 <indexterm zone="colord cd-it8">
322 <primary sortas="b-cd-it8">cd-it8</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="colormgr">
328 <term><command>colormgr</command></term>
329 <listitem>
330 <para>
331 is a text-mode program that allows you to interact with colord on
332 the command line
333 </para>
334 <indexterm zone="colord colormgr">
335 <primary sortas="b-colormgr">colormgr</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="libcolord.so">
341 <term><filename class="libraryfile">libcolord.so</filename></term>
342 <listitem>
343 <para>
344 contains the <application>Colord</application> API functions
345 </para>
346 <indexterm zone="colord libcolord.so">
347 <primary sortas="c-libcolord.so">libcolord.so</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="libcolordcompat.so">
353 <term><filename class="libraryfile">libcolordcompat.so</filename></term>
354 <listitem>
355 <para>
356 contains legacy API functions for compatibility with older
357 applications
358 </para>
359 <indexterm zone="colord libcolordcompat.so">
360 <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="libcolordprivate.so">
366 <term><filename class="libraryfile">libcolordprivate.so</filename></term>
367 <listitem>
368 <para>
369 contains internal API functions for the programs included with
370 <application>Colord</application>
371 </para>
372 <indexterm zone="colord libcolordprivate.so">
373 <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="libcolorhug.so">
379 <term><filename class="libraryfile">libcolorhug.so</filename></term>
380 <listitem>
381 <para>
382 contains a simple display hardware colorimiter
383 </para>
384 <indexterm zone="colord libcolorhug.so">
385 <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389 </variablelist>
390 </sect2>
391
392</sect1>
Note: See TracBrowser for help on using the repository browser.