1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 "94bd795efa1931a34990345e4ac439a8">
|
---|
10 | <!ENTITY colord-size "1.7 MB">
|
---|
11 | <!ENTITY colord-buildsize "18 MB (with tests)">
|
---|
12 | <!ENTITY colord-time "0.4 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 | &lfs122_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">Additional Downloads</bridgehead>
|
---|
72 | <itemizedlist spacing="compact">
|
---|
73 | <listitem>
|
---|
74 | <para>
|
---|
75 | Required patch:
|
---|
76 | <ulink url="&patch-root;/colord-&colord-version;-upstream_fixes-1.patch"/>
|
---|
77 | </para>
|
---|
78 | </listitem>
|
---|
79 | </itemizedlist>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect3">Colord Dependencies</bridgehead>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
84 | <para role="required">
|
---|
85 | <xref linkend="dbus"/>,
|
---|
86 | <xref linkend="glib2"/> (GObject Introspection recommended),
|
---|
87 | <xref linkend="lcms2"/>,
|
---|
88 | <xref linkend="polkit"/>, and
|
---|
89 | <!-- Polkit now needed, see #11481 in Trac -->
|
---|
90 | <xref linkend="sqlite"/>
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
94 | <para role="recommended">
|
---|
95 | <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
|
---|
96 | <xref linkend="libgudev"/>,
|
---|
97 | <xref linkend="libgusb"/>,
|
---|
98 | <phrase revision="systemd" role="runtime"><xref linkend="systemd"/>
|
---|
99 | (runtime),</phrase>
|
---|
100 | and <xref linkend="vala"/>
|
---|
101 | </para>
|
---|
102 |
|
---|
103 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
104 | <para role="optional">
|
---|
105 | <xref linkend="gnome-desktop"/> and
|
---|
106 | <xref linkend="colord-gtk"/> (to build the example tools),
|
---|
107 | <xref linkend="docbook-utils"/>,
|
---|
108 | <xref linkend="gtk-doc"/>,
|
---|
109 | <xref linkend="libxslt"/>,
|
---|
110 | <xref linkend="sane"/>,
|
---|
111 | <ulink url="https://www.argyllcms.com/">ArgyllCMS</ulink>, and
|
---|
112 | <ulink url="https://github.com/scop/bash-completion/">Bash Completion</ulink>
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | </sect2>
|
---|
116 |
|
---|
117 | <sect2 role="installation">
|
---|
118 | <title>Installation of Colord</title>
|
---|
119 |
|
---|
120 | <para>
|
---|
121 | First, fix a misuse of the sqlite API causing a test failure and potential
|
---|
122 | runtime crash<phrase revision='systemd'>, as well as an overly-strict
|
---|
123 | systemd hardening setting causing the systemd service to fail to start</phrase>:
|
---|
124 | </para>
|
---|
125 |
|
---|
126 | <screen><userinput>patch -Np1 -i ../colord-&colord-version;-upstream_fixes-1.patch</userinput></screen>
|
---|
127 |
|
---|
128 | <para>
|
---|
129 | There should be a dedicated user and group to take control of the colord
|
---|
130 | daemon after it has started. Issue the following commands as the
|
---|
131 | <systemitem class="username">root</systemitem> user:
|
---|
132 | </para>
|
---|
133 |
|
---|
134 | <screen role="root"><userinput>groupadd -g 71 colord &&
|
---|
135 | useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
|
---|
136 | -g colord -s /bin/false colord</userinput></screen>
|
---|
137 |
|
---|
138 | <para>
|
---|
139 | Install <application>Colord</application> by running the following
|
---|
140 | commands:
|
---|
141 | </para>
|
---|
142 |
|
---|
143 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
144 | cd build &&
|
---|
145 |
|
---|
146 | meson setup .. \
|
---|
147 | --prefix=/usr \
|
---|
148 | --buildtype=release \
|
---|
149 | -D daemon_user=colord \
|
---|
150 | -D vapi=true \
|
---|
151 | -D systemd=false \
|
---|
152 | -D libcolordcompat=true \
|
---|
153 | -D argyllcms_sensor=false \
|
---|
154 | -D bash_completion=false \
|
---|
155 | -D docs=false \
|
---|
156 | -D man=false &&
|
---|
157 | ninja</userinput></screen>
|
---|
158 |
|
---|
159 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
160 | cd build &&
|
---|
161 |
|
---|
162 | meson setup .. \
|
---|
163 | --prefix=/usr \
|
---|
164 | --buildtype=release \
|
---|
165 | -D daemon_user=colord \
|
---|
166 | -D vapi=true \
|
---|
167 | -D systemd=true \
|
---|
168 | -D libcolordcompat=true \
|
---|
169 | -D argyllcms_sensor=false \
|
---|
170 | -D bash_completion=false \
|
---|
171 | -D docs=false \
|
---|
172 | -D man=false &&
|
---|
173 | ninja</userinput></screen>
|
---|
174 |
|
---|
175 | <para>
|
---|
176 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
177 | </para>
|
---|
178 |
|
---|
179 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
180 |
|
---|
181 | <para>
|
---|
182 | To test the results, issue: <command>ninja test</command>.
|
---|
183 | One test, <filename>colord-self-test-daemon</filename>, will fail if the
|
---|
184 | package is already installed. The test suite must be run with the
|
---|
185 | system-wide D-Bus Daemon running.
|
---|
186 | </para>
|
---|
187 |
|
---|
188 | </sect2>
|
---|
189 |
|
---|
190 | <sect2 role="commands">
|
---|
191 | <title>Command Explanations</title>
|
---|
192 |
|
---|
193 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
194 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
195 |
|
---|
196 | <para>
|
---|
197 | <parameter>-D daemon_user=colord</parameter>: This switch is used
|
---|
198 | so the colord daemon will run as an unprivileged user instead of the
|
---|
199 | <systemitem class="username">root</systemitem> user.
|
---|
200 | </para>
|
---|
201 |
|
---|
202 | <para>
|
---|
203 | <parameter>-D vapi=true</parameter>: This switch enables building
|
---|
204 | the <application>Vala</application> bindings. Remove if you don't have
|
---|
205 | <xref linkend="vala"/> installed.
|
---|
206 | </para>
|
---|
207 |
|
---|
208 | <para revision="sysv">
|
---|
209 | <parameter>-D systemd=false</parameter>: This switch disables
|
---|
210 | support for <application>systemd</application> login in Colord
|
---|
211 | applications.
|
---|
212 | </para>
|
---|
213 |
|
---|
214 | <para revision="systemd">
|
---|
215 | <parameter>-D systemd=true</parameter>: This switch enables
|
---|
216 | installation of the <application>systemd</application> service.
|
---|
217 | </para>
|
---|
218 |
|
---|
219 | <para>
|
---|
220 | <parameter>-D libcolordcompat=true</parameter>: This switch enables
|
---|
221 | building a compatibility library for older packages that use
|
---|
222 | <application>Colord</application>.
|
---|
223 | </para>
|
---|
224 |
|
---|
225 | <para>
|
---|
226 | <parameter>-D argyllcms_sensor=false</parameter>: This switch
|
---|
227 | disables the ArgLLCMS sensor driver. Omit if you have
|
---|
228 | <ulink url="https://www.argyllcms.com/">ArgyllCMS</ulink> installed
|
---|
229 | and wish to use it.
|
---|
230 | </para>
|
---|
231 |
|
---|
232 | <para>
|
---|
233 | <parameter>-D bash_completion=false</parameter>: This switch
|
---|
234 | disables Bash Completion support for Colord applications.
|
---|
235 | </para>
|
---|
236 |
|
---|
237 | <para>
|
---|
238 | <parameter>-D docs=false</parameter>: This switch disables building
|
---|
239 | of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
|
---|
240 | </para>
|
---|
241 |
|
---|
242 | <para>
|
---|
243 | <parameter>-D man=false</parameter>: This switch disables building
|
---|
244 | of man pages. Omit if you have <xref linkend="docbook-utils"/>
|
---|
245 | available. Namespaced versions of the docbook-xsl stylesheets
|
---|
246 | are also required.
|
---|
247 | </para>
|
---|
248 |
|
---|
249 | </sect2>
|
---|
250 |
|
---|
251 | <sect2 role="content">
|
---|
252 | <title>Contents</title>
|
---|
253 |
|
---|
254 | <segmentedlist>
|
---|
255 | <segtitle>Installed Programs</segtitle>
|
---|
256 | <segtitle>Installed Libraries</segtitle>
|
---|
257 | <segtitle>Installed Directories</segtitle>
|
---|
258 |
|
---|
259 | <seglistitem>
|
---|
260 | <seg>
|
---|
261 | cd-create-profile,
|
---|
262 | cd-fix-profile,
|
---|
263 | cd-iccdump,
|
---|
264 | cd-it8, and
|
---|
265 | colormgr
|
---|
266 | </seg>
|
---|
267 | <seg>
|
---|
268 | libcolord.so,
|
---|
269 | libcolordcompat.so,
|
---|
270 | libcolordprivate.so, and
|
---|
271 | libcolorhug.so
|
---|
272 | </seg>
|
---|
273 | <seg>
|
---|
274 | /usr/include/colord-1,
|
---|
275 | /usr/lib/colord-{plugins,sensors},
|
---|
276 | /usr/share/color{d},
|
---|
277 | /usr/share/gtk-doc/html/colord, and
|
---|
278 | /var/lib/colord
|
---|
279 | </seg>
|
---|
280 | </seglistitem>
|
---|
281 | </segmentedlist>
|
---|
282 |
|
---|
283 | <variablelist>
|
---|
284 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
285 | <?dbfo list-presentation="list"?>
|
---|
286 | <?dbhtml list-presentation="table"?>
|
---|
287 |
|
---|
288 | <!-- If the program or library name conflicts (is the same) as the
|
---|
289 | package name, add -prog or -lib to the varlistentry entity id
|
---|
290 | and the 2nd entry of the indexterm zone entity -->
|
---|
291 |
|
---|
292 | <varlistentry id="cd-create-profile">
|
---|
293 | <term><command>cd-create-profile</command></term>
|
---|
294 | <listitem>
|
---|
295 | <para>
|
---|
296 | is the Color Manager Profile Creation Tool
|
---|
297 | </para>
|
---|
298 | <indexterm zone="colord cd-create-profile">
|
---|
299 | <primary sortas="b-cd-create-profile">cd-create-profile</primary>
|
---|
300 | </indexterm>
|
---|
301 | </listitem>
|
---|
302 | </varlistentry>
|
---|
303 |
|
---|
304 | <varlistentry id="cd-fix-profile">
|
---|
305 | <term><command>cd-fix-profile</command></term>
|
---|
306 | <listitem>
|
---|
307 | <para>
|
---|
308 | is a tool used to fix metadata in ICC profiles
|
---|
309 | </para>
|
---|
310 | <indexterm zone="colord cd-fix-profile">
|
---|
311 | <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
|
---|
312 | </indexterm>
|
---|
313 | </listitem>
|
---|
314 | </varlistentry>
|
---|
315 |
|
---|
316 | <varlistentry id="cd-iccdump">
|
---|
317 | <term><command>cd-iccdump</command></term>
|
---|
318 | <listitem>
|
---|
319 | <para>
|
---|
320 | dumps the contents of an ICC profile as human readable text
|
---|
321 | </para>
|
---|
322 | <indexterm zone="colord cd-iccdump">
|
---|
323 | <primary sortas="b-cd-iccdump">cd-iccdump</primary>
|
---|
324 | </indexterm>
|
---|
325 | </listitem>
|
---|
326 | </varlistentry>
|
---|
327 |
|
---|
328 | <varlistentry id="cd-it8">
|
---|
329 | <term><command>cd-it8</command></term>
|
---|
330 | <listitem>
|
---|
331 | <para>
|
---|
332 | is the Color Manager Testing Tool
|
---|
333 | </para>
|
---|
334 | <indexterm zone="colord cd-it8">
|
---|
335 | <primary sortas="b-cd-it8">cd-it8</primary>
|
---|
336 | </indexterm>
|
---|
337 | </listitem>
|
---|
338 | </varlistentry>
|
---|
339 |
|
---|
340 | <varlistentry id="colormgr">
|
---|
341 | <term><command>colormgr</command></term>
|
---|
342 | <listitem>
|
---|
343 | <para>
|
---|
344 | is a text-mode program that allows you to interact with colord on
|
---|
345 | the command line
|
---|
346 | </para>
|
---|
347 | <indexterm zone="colord colormgr">
|
---|
348 | <primary sortas="b-colormgr">colormgr</primary>
|
---|
349 | </indexterm>
|
---|
350 | </listitem>
|
---|
351 | </varlistentry>
|
---|
352 |
|
---|
353 | <varlistentry id="libcolord.so">
|
---|
354 | <term><filename class="libraryfile">libcolord.so</filename></term>
|
---|
355 | <listitem>
|
---|
356 | <para>
|
---|
357 | contains the <application>Colord</application> API functions
|
---|
358 | </para>
|
---|
359 | <indexterm zone="colord libcolord.so">
|
---|
360 | <primary sortas="c-libcolord.so">libcolord.so</primary>
|
---|
361 | </indexterm>
|
---|
362 | </listitem>
|
---|
363 | </varlistentry>
|
---|
364 |
|
---|
365 | <varlistentry id="libcolordcompat.so">
|
---|
366 | <term><filename class="libraryfile">libcolordcompat.so</filename></term>
|
---|
367 | <listitem>
|
---|
368 | <para>
|
---|
369 | contains legacy API functions for compatibility with older
|
---|
370 | applications
|
---|
371 | </para>
|
---|
372 | <indexterm zone="colord libcolordcompat.so">
|
---|
373 | <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
|
---|
374 | </indexterm>
|
---|
375 | </listitem>
|
---|
376 | </varlistentry>
|
---|
377 |
|
---|
378 | <varlistentry id="libcolordprivate.so">
|
---|
379 | <term><filename class="libraryfile">libcolordprivate.so</filename></term>
|
---|
380 | <listitem>
|
---|
381 | <para>
|
---|
382 | contains internal API functions for the programs included with
|
---|
383 | <application>Colord</application>
|
---|
384 | </para>
|
---|
385 | <indexterm zone="colord libcolordprivate.so">
|
---|
386 | <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
|
---|
387 | </indexterm>
|
---|
388 | </listitem>
|
---|
389 | </varlistentry>
|
---|
390 |
|
---|
391 | <varlistentry id="libcolorhug.so">
|
---|
392 | <term><filename class="libraryfile">libcolorhug.so</filename></term>
|
---|
393 | <listitem>
|
---|
394 | <para>
|
---|
395 | contains a simple display hardware colorimiter
|
---|
396 | </para>
|
---|
397 | <indexterm zone="colord libcolorhug.so">
|
---|
398 | <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
|
---|
399 | </indexterm>
|
---|
400 | </listitem>
|
---|
401 | </varlistentry>
|
---|
402 | </variablelist>
|
---|
403 | </sect2>
|
---|
404 |
|
---|
405 | </sect1>
|
---|