source: general/sysutils/colord.xml@ 5867c6d

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 5867c6d was b125bbf, checked in by Xi Ruoyao <xry111@…>, 15 months ago

colord: Make systemd dependency runtime, and add elogind dependency

It uses logind API in libsystemd.so/libelogind.so. Not sure if it's
strong enough to be "recommended", we may demote it later.

Q: Why systemd dependency is runtime, but elogind not?
A: LFS systemd provides libsystemd.so, which contains the logind APIs.
But these APIs will fail at runtime because systemd-logind is missing in
LFS, so we need a runtime dependency. LFS sysv does not provide
libsystemd.so, and libsystemd.so is a symlink to libelogind.so which is
a part of elogind, so it's a build time dependency.
  • Property mode set to 100644
File size: 12.5 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 "7dbdc807495890c13e8242385f4c641f">
10 <!ENTITY colord-size "1.8 MB">
11 <!ENTITY colord-buildsize "32 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
19 <title>Colord-&colord-version;</title>
20
21 <indexterm zone="colord">
22 <primary sortas="a-colord">Colord</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Colord</title>
27
28 <para>
29 <application>Colord</application> is a system service that makes it easy
30 to manage, install, and generate color profiles. It is used mainly by
31 <application>GNOME Color Manager</application> for system integration
32 and use when no users are logged in.
33 </para>
34
35 &lfs113_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&colord-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&colord-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &colord-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &colord-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &colord-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &colord-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <bridgehead renderas="sect3">Colord Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Required</bridgehead>
74 <para role="required">
75 <xref linkend="dbus"/>,
76 <xref linkend="glib2"/>,
77 <xref linkend="lcms2"/>,
78 <xref linkend="polkit"/>, and
79 <!-- Polkit now needed, see #11481 in Trac -->
80 <xref linkend="sqlite"/>
81 </para>
82
83 <bridgehead renderas="sect4">Recommended</bridgehead>
84 <para role="recommended">
85 <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
86 <xref linkend="gobject-introspection"/>,
87 <xref linkend="libgudev"/>,
88 <xref linkend="libgusb"/>,
89 <phrase revision="systemd" role="runtime"><xref linkend="systemd"/>
90 (runtime),</phrase>
91 and <xref linkend="vala"/>
92 </para>
93
94 <bridgehead renderas="sect4">Optional</bridgehead>
95 <para role="optional">
96 <xref linkend="gnome-desktop"/> and
97 <xref linkend="colord-gtk"/> (to build the example tools),
98 <xref linkend="docbook-utils"/>,
99 <xref linkend="gtk-doc"/>,
100 <xref linkend="libxslt"/>,
101 <xref linkend="sane"/>,
102 <ulink url="https://www.argyllcms.com/">ArgyllCMS</ulink>, and
103 <ulink url="https://github.com/scop/bash-completion/">Bash Completion</ulink>
104 </para>
105
106 <para condition="html" role="usernotes">
107 User Notes: <ulink url="&blfs-wiki;/colord"/>
108 </para>
109 </sect2>
110
111 <sect2 role="installation">
112 <title>Installation of Colord</title>
113
114 <para>
115 There should be a dedicated user and group to take control of the colord
116 daemon after it has started. Issue the following commands as the
117 <systemitem class="username">root</systemitem> user:
118 </para>
119
120<screen role="root"><userinput>groupadd -g 71 colord &amp;&amp;
121useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
122 -g colord -s /bin/false colord</userinput></screen>
123
124 <!-- https://github.com/hughsie/colord/pull/146 -->
125 <para>
126 Fix a double free causing a build failure on 32-bit x86 and runtime
127 crashes with some monitors:
128 </para>
129
130<screen><userinput>sed '/cmsUnregisterPluginsTHR/d' -i lib/colord/cd-context-lcms.c</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 setup .. \
141 --prefix=/usr \
142 --buildtype=release \
143 -Ddaemon_user=colord \
144 -Dvapi=true \
145 -Dsystemd=false \
146 -Dlibcolordcompat=true \
147 -Dargyllcms_sensor=false \
148 -Dbash_completion=false \
149 -Ddocs=false \
150 -Dman=false &amp;&amp;
151ninja</userinput></screen>
152
153<screen revision="systemd"><userinput>mkdir build &amp;&amp;
154cd build &amp;&amp;
155
156meson setup .. \
157 --prefix=/usr \
158 --buildtype=release \
159 -Ddaemon_user=colord \
160 -Dvapi=true \
161 -Dsystemd=true \
162 -Dlibcolordcompat=true \
163 -Dargyllcms_sensor=false \
164 -Dbash_completion=false \
165 -Ddocs=false \
166 -Dman=false &amp;&amp;
167ninja</userinput></screen>
168
169 <para>
170 Now, as the <systemitem class="username">root</systemitem> user:
171 </para>
172
173<screen role="root"><userinput>ninja install</userinput></screen>
174
175 <para>
176 To test the results, issue: <command>ninja test</command>.
177 One test, <filename>colord-self-test-daemon</filename>, will fail if the
178 package is already installed. The test suite must be run with the
179 system-wide D-Bus Daemon running.
180 </para>
181
182 </sect2>
183
184 <sect2 role="commands">
185 <title>Command Explanations</title>
186
187 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
188 href="../../xincludes/meson-buildtype-release.xml"/>
189
190 <para>
191 <parameter>-Ddaemon_user=colord</parameter>: This switch is used
192 so the colord daemon will run as an unprivileged user instead of the
193 <systemitem class="username">root</systemitem> user.
194 </para>
195
196 <para>
197 <parameter>-Dvapi=true</parameter>: This switch enables building
198 the <application>Vala</application> bindings. Remove if you don't have
199 <xref linkend="vala"/> installed.
200 </para>
201
202 <para revision="sysv">
203 <parameter>-Dsystemd=false</parameter>: This switch disables
204 support for <application>systemd</application> login in Colord
205 applications.
206 </para>
207
208 <para revision="systemd">
209 <parameter>-Dsystemd=true</parameter>: This switch enables
210 installation of the <application>systemd</application> service.
211 </para>
212
213 <para>
214 <parameter>-Dlibcolordcompat=true</parameter>: This switch enables
215 building a compatibility library for older packages that use
216 <application>Colord</application>.
217 </para>
218
219 <para>
220 <parameter>-Dargyllcms_sensor=false</parameter>: This switch
221 disables the ArgLLCMS sensor driver. Omit if you have
222 <ulink url="https://www.argyllcms.com/">ArgyllCMS</ulink> installed
223 and wish to use it.
224 </para>
225
226 <para>
227 <parameter>-Dbash_completion=false</parameter>: This switch
228 disables Bash Completion support for Colord applications.
229 </para>
230
231 <para>
232 <parameter>-Ddocs=false</parameter>: This switch disables building
233 of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
234 </para>
235
236 <para>
237 <parameter>-Dman=false</parameter>: This switch disables building
238 of man pages. Omit if you have <xref linkend="docbook-utils"/>
239 available. Namespaced versions of the docbook-xsl stylesheets
240 are also required.
241 </para>
242
243 </sect2>
244
245 <sect2 role="content">
246 <title>Contents</title>
247
248 <segmentedlist>
249 <segtitle>Installed Programs</segtitle>
250 <segtitle>Installed Libraries</segtitle>
251 <segtitle>Installed Directories</segtitle>
252
253 <seglistitem>
254 <seg>
255 cd-create-profile,
256 cd-fix-profile,
257 cd-iccdump,
258 cd-it8, and
259 colormgr
260 </seg>
261 <seg>
262 libcolord.so,
263 libcolordcompat.so,
264 libcolordprivate.so, and
265 libcolorhug.so
266 </seg>
267 <seg>
268 /usr/include/colord-1,
269 /usr/lib/colord-{plugins,sensors},
270 /usr/share/color{d},
271 /usr/share/gtk-doc/html/colord, and
272 /var/lib/colord
273 </seg>
274 </seglistitem>
275 </segmentedlist>
276
277 <variablelist>
278 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
279 <?dbfo list-presentation="list"?>
280 <?dbhtml list-presentation="table"?>
281
282 <!-- If the program or library name conflicts (is the same) as the
283 package name, add -prog or -lib to the varlistentry entity id
284 and the 2nd entry of the indexterm zone entity -->
285
286 <varlistentry id="cd-create-profile">
287 <term><command>cd-create-profile</command></term>
288 <listitem>
289 <para>
290 is the Color Manager Profile Creation Tool
291 </para>
292 <indexterm zone="colord cd-create-profile">
293 <primary sortas="b-cd-create-profile">cd-create-profile</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="cd-fix-profile">
299 <term><command>cd-fix-profile</command></term>
300 <listitem>
301 <para>
302 is a tool used to fix metadata in ICC profiles
303 </para>
304 <indexterm zone="colord cd-fix-profile">
305 <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="cd-iccdump">
311 <term><command>cd-iccdump</command></term>
312 <listitem>
313 <para>
314 dumps the contents of an ICC profile as human readable text
315 </para>
316 <indexterm zone="colord cd-iccdump">
317 <primary sortas="b-cd-iccdump">cd-iccdump</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="cd-it8">
323 <term><command>cd-it8</command></term>
324 <listitem>
325 <para>
326 is the Color Manager Testing Tool
327 </para>
328 <indexterm zone="colord cd-it8">
329 <primary sortas="b-cd-it8">cd-it8</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry id="colormgr">
335 <term><command>colormgr</command></term>
336 <listitem>
337 <para>
338 is a text-mode program that allows you to interact with colord on
339 the command line
340 </para>
341 <indexterm zone="colord colormgr">
342 <primary sortas="b-colormgr">colormgr</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="libcolord.so">
348 <term><filename class="libraryfile">libcolord.so</filename></term>
349 <listitem>
350 <para>
351 contains the <application>Colord</application> API functions
352 </para>
353 <indexterm zone="colord libcolord.so">
354 <primary sortas="c-libcolord.so">libcolord.so</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="libcolordcompat.so">
360 <term><filename class="libraryfile">libcolordcompat.so</filename></term>
361 <listitem>
362 <para>
363 contains legacy API functions for compatibility with older
364 applications
365 </para>
366 <indexterm zone="colord libcolordcompat.so">
367 <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="libcolordprivate.so">
373 <term><filename class="libraryfile">libcolordprivate.so</filename></term>
374 <listitem>
375 <para>
376 contains internal API functions for the programs included with
377 <application>Colord</application>
378 </para>
379 <indexterm zone="colord libcolordprivate.so">
380 <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="libcolorhug.so">
386 <term><filename class="libraryfile">libcolorhug.so</filename></term>
387 <listitem>
388 <para>
389 contains a simple display hardware colorimiter
390 </para>
391 <indexterm zone="colord libcolorhug.so">
392 <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396 </variablelist>
397 </sect2>
398
399</sect1>
Note: See TracBrowser for help on using the repository browser.