source: general/sysutils/colord.xml@ 932eaae

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 932eaae was 932eaae, checked in by Douglas R. Reno <renodr@…>, 17 months ago

Final tags for the night

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23558 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 "32c2709a6002d9ee750483aaed6379c8">
10 <!ENTITY colord-size "1.8 MB">
11 <!ENTITY colord-buildsize "23 MB (with tests)">
12 <!ENTITY colord-time "0.1 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 &lfs10_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 --sysconfdir=/etc \
142 --localstatedir=/var \
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 --sysconfdir=/etc \
158 --localstatedir=/var \
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 -k 2 test</command>.
177 One test, <filename>colord-self-test-daemon</filename>, will fail.
178 The test suite must be run after the package is installed, and the
179 system-wide D-Bus Daemon must be running.
180 </para>
181
182 </sect2>
183
184 <sect2 role="commands">
185 <title>Command Explanations</title>
186
187 <para>
188 <parameter>-Ddaemon_user=colord</parameter>: This switch is used
189 so the colord daemon will run as an unprivileged user instead of the
190 <systemitem class="username">root</systemitem> user.
191 </para>
192
193 <para>
194 <parameter>-Dvapi=true</parameter>: This switch enables building
195 the <application>Vala</application> bindings. Remove if you don't have
196 <xref linkend="vala"/> installed.
197 </para>
198
199 <para revision="sysv">
200 <parameter>-Dsystemd=false</parameter>: This switch disables
201 support for <application>systemd</application> login in Colord
202 applications.
203 </para>
204
205 <para revision="systemd">
206 <parameter>-Dsystemd=true</parameter>: This switch enables
207 installation of the <application>systemd</application> service.
208 </para>
209
210 <para>
211 <parameter>-Dlibcolordcompat=true</parameter>: This switch enables
212 building a compatibility library for older packages that use
213 <application>Colord</application>.
214 </para>
215
216 <para>
217 <parameter>-Dargyllcms_sensor=false</parameter>: This switch
218 disables the ArgLLCMS sensor driver. Omit if you have
219 <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
220 and wish to use it.
221 </para>
222
223 <para>
224 <parameter>-Dbash_completion=false</parameter>: This switch
225 disables Bash Completion support for Colord applications.
226 </para>
227
228 <para>
229 <parameter>-Ddocs=false</parameter>: This switch disables building
230 of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
231 </para>
232
233 <para>
234 <parameter>-Dman=false</parameter>: This switch disables building
235 of man pages. Omit if you have <xref linkend="docbook-utils"/>
236 available. Namespaced versions of the docbook-xsl stylesheets
237 are also required.
238 </para>
239
240 </sect2>
241
242 <sect2 role="content">
243 <title>Contents</title>
244
245 <segmentedlist>
246 <segtitle>Installed Programs</segtitle>
247 <segtitle>Installed Libraries</segtitle>
248 <segtitle>Installed Directories</segtitle>
249
250 <seglistitem>
251 <seg>
252 cd-create-profile,
253 cd-fix-profile,
254 cd-iccdump,
255 cd-it8, and
256 colormgr
257 </seg>
258 <seg>
259 libcolord.so,
260 libcolordcompat.so,
261 libcolordprivate.so, and
262 libcolorhug.so
263 </seg>
264 <seg>
265 /usr/include/colord-1,
266 /usr/lib/colord-{plugins,sensors},
267 /usr/share/color{d},
268 /usr/share/gtk-doc/html/colord, and
269 /var/lib/colord
270 </seg>
271 </seglistitem>
272 </segmentedlist>
273
274 <variablelist>
275 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
276 <?dbfo list-presentation="list"?>
277 <?dbhtml list-presentation="table"?>
278
279 <!-- If the program or library name conflicts (is the same) as the
280 package name, add -prog or -lib to the varlistentry entity id
281 and the 2nd entry of the indexterm zone entity -->
282
283 <varlistentry id="cd-create-profile">
284 <term><command>cd-create-profile</command></term>
285 <listitem>
286 <para>
287 is the Color Manager Profile Creation Tool.
288 </para>
289 <indexterm zone="colord cd-create-profile">
290 <primary sortas="b-cd-create-profile">cd-create-profile</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="cd-fix-profile">
296 <term><command>cd-fix-profile</command></term>
297 <listitem>
298 <para>
299 is a tool used to fix metadata in ICC profiles.
300 </para>
301 <indexterm zone="colord cd-fix-profile">
302 <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="cd-iccdump">
308 <term><command>cd-iccdump</command></term>
309 <listitem>
310 <para>
311 dumps the contents of an ICC profile as human readable text.
312 </para>
313 <indexterm zone="colord cd-iccdump">
314 <primary sortas="b-cd-iccdump">cd-iccdump</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="cd-it8">
320 <term><command>cd-it8</command></term>
321 <listitem>
322 <para>
323 is the Color Manager Testing Tool.
324 </para>
325 <indexterm zone="colord cd-it8">
326 <primary sortas="b-cd-it8">cd-it8</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="colormgr">
332 <term><command>colormgr</command></term>
333 <listitem>
334 <para>
335 is a text-mode program that allows you to interact with colord on
336 the command line.
337 </para>
338 <indexterm zone="colord colormgr">
339 <primary sortas="b-colormgr">colormgr</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="libcolord.so">
345 <term><filename class="libraryfile">libcolord.so</filename></term>
346 <listitem>
347 <para>
348 contains the <application>Colord</application> API functions.
349 </para>
350 <indexterm zone="colord libcolord.so">
351 <primary sortas="c-libcolord.so">libcolord.so</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355
356 <varlistentry id="libcolordcompat.so">
357 <term><filename class="libraryfile">libcolordcompat.so</filename></term>
358 <listitem>
359 <para>
360 contains legacy API functions for compatibility with older
361 applications.
362 </para>
363 <indexterm zone="colord libcolordcompat.so">
364 <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="libcolordprivate.so">
370 <term><filename class="libraryfile">libcolordprivate.so</filename></term>
371 <listitem>
372 <para>
373 contains internal API functions for the programs included with
374 <application>Colord</application>.
375 </para>
376 <indexterm zone="colord libcolordprivate.so">
377 <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="libcolorhug.so">
383 <term><filename class="libraryfile">libcolorhug.so</filename></term>
384 <listitem>
385 <para>
386 contains a simple display hardware colorimiter.
387 </para>
388 <indexterm zone="colord libcolorhug.so">
389 <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393 </variablelist>
394 </sect2>
395</sect1>
Note: See TracBrowser for help on using the repository browser.