source: general/sysutils/colord.xml@ dd51538

trunk
Last change on this file since dd51538 was dd51538, checked in by Douglas R. Reno <renodr@…>, 2 months ago

colord: Add missing dependencies that are mentioned in the Command
Explanations

  • 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 "adc4501b54fb8667ee99f64cff87e12d">
10 <!ENTITY colord-size "1.8 MB">
11 <!ENTITY colord-buildsize "31 MB (with tests)">
12 <!ENTITY colord-time "0.3 SBU (with tests)">
13]>
14
15<sect1 id="colord" xreflabel="colord-&colord-version;">
16 <?dbhtml filename="colord.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Colord-&colord-version;</title>
23
24 <indexterm zone="colord">
25 <primary sortas="a-colord">Colord</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Colord</title>
30
31 <para>
32 <application>Colord</application> is a system service that makes it easy
33 to manage, install, and generate color profiles. It is used mainly by
34 <application>GNOME Color Manager</application> for system integration
35 and use when no users are logged in.
36 </para>
37
38 &lfs101_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&colord-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&colord-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &colord-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &colord-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &colord-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &colord-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">Colord Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="dbus"/>,
79 <xref linkend="glib2"/>,
80 <xref linkend="lcms2"/>,
81 <xref linkend="polkit"/>, and
82 <!-- Polkit now needed, see #11481 in Trac -->
83 <xref linkend="sqlite"/>
84 </para>
85
86 <bridgehead renderas="sect4">Recommended</bridgehead>
87 <para role="recommended">
88 <xref linkend="gobject-introspection"/>,
89 <xref linkend="libgudev"/>,
90 <xref linkend="libgusb"/>,
91 <phrase revision="sysv">and</phrase>
92 <phrase revision="systemd"><xref linkend="systemd"/>, and</phrase>
93 <xref linkend="vala"/>
94 </para>
95
96 <bridgehead renderas="sect4">Optional</bridgehead>
97 <para role="optional">
98 <xref linkend="gnome-desktop"/> and
99 <xref linkend="colord-gtk"/> (to build the example tools),
100 <xref linkend="docbook-utils"/>,
101 <xref linkend="gtk-doc"/>,
102 <xref linkend="libxslt"/>,
103 <xref linkend="sane"/>,
104 <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink>, and
105 <ulink url="https://github.com/scop/bash-completion/">Bash Completion</ulink>
106 </para>
107
108 <para condition="html" role="usernotes">
109 User Notes: <ulink url="&blfs-wiki;/colord"/>
110 </para>
111 </sect2>
112
113 <sect2 role="installation">
114 <title>Installation of Colord</title>
115
116 <para>
117 There should be a dedicated user and group to take control of the colord
118 daemon after it has started. Issue the following commands as the
119 <systemitem class="username">root</systemitem> user:
120 </para>
121
122<screen role="root"><userinput>groupadd -g 71 colord &amp;&amp;
123useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
124 -g colord -s /bin/false colord</userinput></screen>
125
126 <para>
127 First, clean up about 100 warnings:
128 </para>
129
130<screen><userinput>mv po/fur.po po/ur.po &amp;&amp;
131sed -i 's/fur/ur/' po/LINGUAS</userinput></screen>
132
133 <para>
134 Install <application>Colord</application> by running the following
135 commands:
136 </para>
137
138<screen revision="sysv"><userinput>mkdir build &amp;&amp;
139cd build &amp;&amp;
140
141meson --prefix=/usr \
142 -Ddaemon_user=colord \
143 -Dvapi=true \
144 -Dsystemd=false \
145 -Dlibcolordcompat=true \
146 -Dargyllcms_sensor=false \
147 -Dbash_completion=false \
148 -Ddocs=false \
149 -Dman=false .. &amp;&amp;
150ninja</userinput></screen>
151
152<screen revision="systemd"><userinput>mkdir build &amp;&amp;
153cd build &amp;&amp;
154
155meson --prefix=/usr \
156 -Ddaemon_user=colord \
157 -Dvapi=true \
158 -Dsystemd=true \
159 -Dlibcolordcompat=true \
160 -Dargyllcms_sensor=false \
161 -Dbash_completion=false \
162 -Ddocs=false \
163 -Dman=false .. &amp;&amp;
164ninja</userinput></screen>
165
166 <para>
167 Now, as the <systemitem class="username">root</systemitem> user:
168 </para>
169
170<screen role="root"><userinput>ninja install</userinput></screen>
171
172 <para>
173 To test the results, issue: <command>ninja -k 2 test</command>.
174 One test, <filename>colord-self-test-daemon</filename>, will fail.
175 The test suite must be run after the package is installed, and the
176 system-wide D-Bus Daemon must be running.
177 </para>
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para>
185 <parameter>-Ddaemon_user=colord</parameter>: This switch is used
186 so the colord daemon will run as an unprivileged user instead of the
187 <systemitem class="username">root</systemitem> user.
188 </para>
189
190 <para>
191 <parameter>-Dvapi=true</parameter>: This switch enables building
192 the <application>Vala</application> bindings. Remove if you don't have
193 <xref linkend="vala"/> installed.
194 </para>
195
196 <para revision="sysv">
197 <parameter>-Dsystemd=false</parameter>: This switch disables
198 support for <application>systemd</application> login in Colord
199 applications.
200 </para>
201
202 <para revision="systemd">
203 <parameter>-Dsystemd=true</parameter>: This switch enables
204 installation of the <application>systemd</application> service.
205 </para>
206
207 <para>
208 <parameter>-Dlibcolordcompat=true</parameter>: This switch enables
209 building a compatibility library for older packages that use
210 <application>Colord</application>.
211 </para>
212
213 <para>
214 <parameter>-Dargyllcms_sensor=false</parameter>: This switch
215 disables the ArgLLCMS sensor driver. Omit if you have
216 <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
217 and wish to use it.
218 </para>
219
220 <para>
221 <parameter>-Dbash_completion=false</parameter>: This switch
222 disables Bash Completion support for Colord applications.
223 </para>
224
225 <para>
226 <parameter>-Ddocs=false</parameter>: This switch disables building
227 of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
228 </para>
229
230 <para>
231 <parameter>-Dman=false</parameter>: This switch disables building
232 of man pages. Omit if you have <xref linkend="docbook-utils"/>
233 available. Namespaced versions of the docbook-xsl stylesheets
234 are also required.
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
393</sect1>
Note: See TracBrowser for help on using the repository browser.