source: general/sysutils/colord.xml@ 7ae59ab

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 7ae59ab was 7ae59ab, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

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