source: general/sysutils/colord.xml@ 6b7881d

10.0 10.1 11.0 11.1 11.2 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 6b7881d was 6b7881d, checked in by Pierre Labastie <pieere@…>, 5 years ago

Fix build of colord-1.3.5 for SysV, plus fix typo(s)

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19327 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 13.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 "a8e7fcf0a45383ca7a65cef91ca5e019">
10 <!ENTITY colord-size "1.2 MB">
11 <!ENTITY colord-buildsize "44 MB (with tests)">
12 <!ENTITY colord-time "0.7 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 &lfs81_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"/>, and
82 <xref linkend="sqlite"/>
83 </para>
84
85 <bridgehead renderas="sect4">Recommended</bridgehead>
86 <para role="recommended">
87 <xref linkend="gobject-introspection"/>,
88 <xref linkend="libgudev"/>,
89 <xref linkend="libgusb"/>,
90 <xref linkend="polkit"/>, <phrase revision="sysv">and</phrase>
91 <phrase revision="systemd"><xref linkend="systemd"/>, and</phrase>
92 <xref linkend="vala"/>
93 </para>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 <xref linkend="docbook-utils"/>,
98 <xref linkend="gnome-desktop"/> and
99 <xref linkend="colord-gtk"/> (to build the example tools),
100 <xref linkend="gtk-doc"/>,
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<!-- Is this still relevant?
115 <warning>
116 <para>
117 This package will overwrite any previous version of Colord that you
118 may have on your system. This package is a development version
119 and is only intended to be used by gnome-color-manager at this time.
120 </para>
121 </warning>-->
122
123 <para>
124 There should be a dedicated user and group to take control of the colord
125 daemon after it has started. Issue the following commands as the
126 <systemitem class="username">root</systemitem> user:
127 </para>
128
129<screen role="root"><userinput>groupadd -g 71 colord &amp;&amp;
130useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
131 -g colord -s /bin/false colord</userinput></screen>
132
133 <para>
134 Install <application>Colord</application> by running the following
135 commands:
136 </para>
137
138<screen revision="sysv"><userinput>./configure --prefix=/usr \
139 --sysconfdir=/etc \
140 --localstatedir=/var \
141 --with-daemon-user=colord \
142 --enable-vala \
143 --enable-daemon \
144 --enable-session-helper \
145 --enable-libcolordcompat \
146 --disable-rpath \
147 --disable-argyllcms-sensor \
148 --disable-bash-completion \
149 --disable-systemd-login \
150 --disable-static &amp;&amp;
151make</userinput></screen>
152
153<screen revision="systemd"><userinput>./configure --prefix=/usr \
154 --sysconfdir=/etc \
155 --localstatedir=/var \
156 --with-daemon-user=colord \
157 --enable-vala \
158 --enable-daemon \
159 --enable-session-helper \
160 --enable-libcolordcompat \
161 --disable-rpath \
162 --disable-argyllcms-sensor \
163 --disable-bash-completion \
164 --disable-static &amp;&amp;
165make</userinput></screen>
166
167 <para>
168 Now, as the <systemitem class="username">root</systemitem> user:
169 </para>
170
171<screen role="root"><userinput>make install</userinput></screen>
172
173 <para>
174 To test the results, issue: <command>make -k check</command>.
175 At least one test,
176 <filename>./lib/colord/.libs/lt-cd-test-daemon</filename>, may 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 <para>
187 <parameter>--with-daemon-user=colord</parameter>: This switch is used
188 so the colord daemon will run as an unprivileged user instead of the
189 <systemitem class="username">root</systemitem> user.
190 </para>
191
192 <para>
193 <parameter>--enable-vala</parameter>: This switch enables building the
194 <application>Vala</application> bindings. Remove if you don't have
195 <xref linkend="vala"/> installed.
196 </para>
197
198 <para>
199 <parameter>--enable-daemon</parameter>: This switch enables building
200 the <application>Colord</application> daemon.
201 </para>
202
203 <para>
204 <parameter>--enable-session-helper</parameter>: This switch enables
205 building the session helper for <application>Colord</application>.
206 </para>
207
208 <para>
209 <parameter>--enable-libcolordcompat</parameter>: This switch enables
210 building a compatibility library for older packages that use
211 <application>Colord</application>.
212 </para>
213
214 <para>
215 <parameter>--disable-rpath</parameter>: This switch prevents the build
216 process from hard-coding library paths into its executables.
217 </para>
218
219 <para>
220 <parameter>--disable-argyllcms-sensor</parameter>: This switch disables
221 the ArgLLCMS sensor driver. Omit if you have
222 <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
223 and wish to use it.
224 </para>
225
226 <para>
227 <parameter>--disable-bash-completion</parameter>: This switch disables
228 Bash Completion support for Colord applications.
229 </para>
230
231 <para revision="sysv">
232 <parameter>--disable-systemd-login</parameter>: This switch disables
233 support for <application>systemd</application> login in Colord
234 applications. Default is to enable, and to fail if systemd is not found
235 on the system.
236 </para>
237
238 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
239 href="../../xincludes/static-libraries.xml"/>
240
241 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
242 href="../../xincludes/gtk-doc-rebuild.xml"/>
243
244 <para>
245 <option>--disable-gusb</option>: Use this switch if you don't have
246 <application>libgusb</application> installed.
247 </para>
248
249 <para>
250 <option>--disable-udev</option>: Use this switch if you don't have
251 <application>libgudev</application> installed.
252 </para>
253
254 <para>
255 <option>--disable-polkit</option>: Use this switch if you don't have
256 <application>polkit</application> installed.
257 </para>
258
259 </sect2>
260
261 <sect2 role="content">
262 <title>Contents</title>
263
264 <segmentedlist>
265 <segtitle>Installed Programs</segtitle>
266 <segtitle>Installed Libraries</segtitle>
267 <segtitle>Installed Directories</segtitle>
268
269 <seglistitem>
270 <seg>
271 cd-create-profile,
272 cd-fix-profile,
273 cd-iccdump,
274 cd-it8, and
275 colormgr
276 </seg>
277 <seg>
278 libcolord.so,
279 libcolordcompat.so,
280 libcolordprivate.so, and
281 libcolorhug.so
282 </seg>
283 <seg>
284 /usr/include/colord-1,
285 /usr/lib/colord-{plugins,sensors},
286 /usr/share/color{d},
287 /usr/share/gtk-doc/html/colord, and
288 /var/lib/colord
289 </seg>
290 </seglistitem>
291 </segmentedlist>
292
293 <variablelist>
294 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
295 <?dbfo list-presentation="list"?>
296 <?dbhtml list-presentation="table"?>
297
298 <!-- If the program or library name conflicts (is the same) as the
299 package name, add -prog or -lib to the varlistentry entity id
300 and the 2nd entry of the indexterm zone entity -->
301
302 <varlistentry id="cd-create-profile">
303 <term><command>cd-create-profile</command></term>
304 <listitem>
305 <para>
306 is the Color Manager Profile Creation Tool.
307 </para>
308 <indexterm zone="colord cd-create-profile">
309 <primary sortas="b-cd-create-profile">cd-create-profile</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="cd-fix-profile">
315 <term><command>cd-fix-profile</command></term>
316 <listitem>
317 <para>
318 is a tool used to fix metadata in ICC profiles.
319 </para>
320 <indexterm zone="colord cd-fix-profile">
321 <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="cd-iccdump">
327 <term><command>cd-iccdump</command></term>
328 <listitem>
329 <para>
330 dumps the contents of an ICC profile as human readable text.
331 </para>
332 <indexterm zone="colord cd-iccdump">
333 <primary sortas="b-cd-iccdump">cd-iccdump</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="cd-it8">
339 <term><command>cd-it8</command></term>
340 <listitem>
341 <para>
342 is the Color Manager Testing Tool.
343 </para>
344 <indexterm zone="colord cd-it8">
345 <primary sortas="b-cd-it8">cd-it8</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="colormgr">
351 <term><command>colormgr</command></term>
352 <listitem>
353 <para>
354 is a text-mode program that allows you to interact with colord on
355 the command line.
356 </para>
357 <indexterm zone="colord colormgr">
358 <primary sortas="b-colormgr">colormgr</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="libcolord.so">
364 <term><filename class="libraryfile">libcolord.so</filename></term>
365 <listitem>
366 <para>
367 contains the <application>Colord</application> API functions.
368 </para>
369 <indexterm zone="colord libcolord.so">
370 <primary sortas="c-libcolord.so">libcolord.so</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="libcolordcompat.so">
376 <term><filename class="libraryfile">libcolordcompat.so</filename></term>
377 <listitem>
378 <para>
379 contains legacy API functions for compatibility with older
380 applications.
381 </para>
382 <indexterm zone="colord libcolordcompat.so">
383 <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="libcolordprivate.so">
389 <term><filename class="libraryfile">libcolordprivate.so</filename></term>
390 <listitem>
391 <para>
392 contains internal API functions for the programs included with
393 <application>Colord</application>.
394 </para>
395 <indexterm zone="colord libcolordprivate.so">
396 <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="libcolorhug.so">
402 <term><filename class="libraryfile">libcolorhug.so</filename></term>
403 <listitem>
404 <para>
405 contains a simple display hardware colorimiter.
406 </para>
407 <indexterm zone="colord libcolorhug.so">
408 <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412 </variablelist>
413 </sect2>
414</sect1>
Note: See TracBrowser for help on using the repository browser.