source: general/sysutils/colord.xml@ 2d0650b

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 9.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 2d0650b was ad112fd5, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Update to cups-2.2.12.
Update to node.js-10.16.3.
Update to gtk-doc-1.32.
Tag qt5 and its dependencies.

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