source: general/sysutils/colord.xml@ 07499ecc

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules 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 07499ecc was 43b1dad3, checked in by Bruce Dubbs <bdubbs@…>, 6 years ago

Update to logrotate-3.14.0
Most remaining tags in genlib, genutils, and sysutils

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20396 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 12.2 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 "f032ecac927e9078c41fff97800441e8">
10 <!ENTITY colord-size "1.8 MB">
11 <!ENTITY colord-buildsize "22 MB (with tests)">
12 <!ENTITY colord-time "0.2 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 &lfs83_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
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"/> avaialable.
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 avaialable.
235 </para>
236
237 </sect2>
238
239 <sect2 role="content">
240 <title>Contents</title>
241
242 <segmentedlist>
243 <segtitle>Installed Programs</segtitle>
244 <segtitle>Installed Libraries</segtitle>
245 <segtitle>Installed Directories</segtitle>
246
247 <seglistitem>
248 <seg>
249 cd-create-profile,
250 cd-fix-profile,
251 cd-iccdump,
252 cd-it8, and
253 colormgr
254 </seg>
255 <seg>
256 libcolord.so,
257 libcolordcompat.so,
258 libcolordprivate.so, and
259 libcolorhug.so
260 </seg>
261 <seg>
262 /usr/include/colord-1,
263 /usr/lib/colord-{plugins,sensors},
264 /usr/share/color{d},
265 /usr/share/gtk-doc/html/colord, and
266 /var/lib/colord
267 </seg>
268 </seglistitem>
269 </segmentedlist>
270
271 <variablelist>
272 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
273 <?dbfo list-presentation="list"?>
274 <?dbhtml list-presentation="table"?>
275
276 <!-- If the program or library name conflicts (is the same) as the
277 package name, add -prog or -lib to the varlistentry entity id
278 and the 2nd entry of the indexterm zone entity -->
279
280 <varlistentry id="cd-create-profile">
281 <term><command>cd-create-profile</command></term>
282 <listitem>
283 <para>
284 is the Color Manager Profile Creation Tool.
285 </para>
286 <indexterm zone="colord cd-create-profile">
287 <primary sortas="b-cd-create-profile">cd-create-profile</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="cd-fix-profile">
293 <term><command>cd-fix-profile</command></term>
294 <listitem>
295 <para>
296 is a tool used to fix metadata in ICC profiles.
297 </para>
298 <indexterm zone="colord cd-fix-profile">
299 <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="cd-iccdump">
305 <term><command>cd-iccdump</command></term>
306 <listitem>
307 <para>
308 dumps the contents of an ICC profile as human readable text.
309 </para>
310 <indexterm zone="colord cd-iccdump">
311 <primary sortas="b-cd-iccdump">cd-iccdump</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="cd-it8">
317 <term><command>cd-it8</command></term>
318 <listitem>
319 <para>
320 is the Color Manager Testing Tool.
321 </para>
322 <indexterm zone="colord cd-it8">
323 <primary sortas="b-cd-it8">cd-it8</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="colormgr">
329 <term><command>colormgr</command></term>
330 <listitem>
331 <para>
332 is a text-mode program that allows you to interact with colord on
333 the command line.
334 </para>
335 <indexterm zone="colord colormgr">
336 <primary sortas="b-colormgr">colormgr</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="libcolord.so">
342 <term><filename class="libraryfile">libcolord.so</filename></term>
343 <listitem>
344 <para>
345 contains the <application>Colord</application> API functions.
346 </para>
347 <indexterm zone="colord libcolord.so">
348 <primary sortas="c-libcolord.so">libcolord.so</primary>
349 </indexterm>
350 </listitem>
351 </varlistentry>
352
353 <varlistentry id="libcolordcompat.so">
354 <term><filename class="libraryfile">libcolordcompat.so</filename></term>
355 <listitem>
356 <para>
357 contains legacy API functions for compatibility with older
358 applications.
359 </para>
360 <indexterm zone="colord libcolordcompat.so">
361 <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="libcolordprivate.so">
367 <term><filename class="libraryfile">libcolordprivate.so</filename></term>
368 <listitem>
369 <para>
370 contains internal API functions for the programs included with
371 <application>Colord</application>.
372 </para>
373 <indexterm zone="colord libcolordprivate.so">
374 <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="libcolorhug.so">
380 <term><filename class="libraryfile">libcolorhug.so</filename></term>
381 <listitem>
382 <para>
383 contains a simple display hardware colorimiter.
384 </para>
385 <indexterm zone="colord libcolorhug.so">
386 <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390 </variablelist>
391 </sect2>
392</sect1>
Note: See TracBrowser for help on using the repository browser.