source: general/sysutils/colord1.xml@ 77a6d25

10.0 10.1 11.0 7.10 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 77a6d25 was 77a6d25, checked in by Igor Živković <igor@…>, 5 years ago

misspellings

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

  • Property mode set to 100644
File size: 12.4 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 colord1-download-http "http://www.freedesktop.org/software/colord/releases/colord-&colord1-version;.tar.xz">
8 <!ENTITY colord1-download-ftp " ">
9 <!ENTITY colord1-md5sum "63ad39539845040141e8deffde11cf85">
10 <!ENTITY colord1-size "1.2 MB">
11 <!ENTITY colord1-buildsize "39 MB (with tests)">
12 <!ENTITY colord1-time "0.4 SBU (with tests)">
13]>
14
15<sect1 id="colord1" xreflabel="colord-&colord1-version;" revision="systemd">
16 <?dbhtml filename="colord1.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Colord-&colord1-version;</title>
24
25 <indexterm zone="colord1">
26 <primary sortas="a-colord1">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 &lfs7a_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&colord1-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&colord1-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &colord1-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &colord1-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &colord1-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &colord1-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"/>,
91 <xref linkend="systemd"/>, and
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/">ArgLLCMS</ulink>, and
104 <ulink url="http://www.bash-completion.alioth-debian.org/">Bash Completion</ulink>
105 </para>
106
107 <para condition="html" role="usernotes">
108 User Notes: <ulink url="&blfs-wiki;/colord1"/>
109 </para>
110 </sect2>
111
112 <sect2 role="installation">
113 <title>Installation of Colord</title>
114
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><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-static &amp;&amp;
150make</userinput></screen>
151
152 <para>
153 Now, as the <systemitem class="username">root</systemitem> user:
154 </para>
155
156<screen role="root"><userinput>make install</userinput></screen>
157
158 <para>
159 To test the results, issue: <command>make -k check</command>.
160 At least one test,
161 <filename>./lib/colord/.libs/lt-cd-test-daemon</filename>, may fail.
162 The test suite must be run after the package is installed, and the
163 system-wide D-Bus Daemon must be running.
164 </para>
165
166 </sect2>
167
168 <sect2 role="commands">
169 <title>Command Explanations</title>
170
171 <para>
172 <parameter>--with-daemon-user=colord</parameter>: This switch is used
173 so the colord daemon will run as an unprivileged user instead of the
174 <systemitem class="username">root</systemitem> user.
175 </para>
176
177 <para>
178 <parameter>--enable-vala</parameter>: This switch enables building the
179 <application>Vala</application> bindings. Remove if you don't have
180 <xref linkend="vala"/> installed.
181 </para>
182
183 <para>
184 <parameter>--enable-daemon</parameter>: This switch enables building
185 the <application>Colord</application> daemon.
186 </para>
187
188 <para>
189 <parameter>--enable-session-helper</parameter>: This switch enables
190 building the session helper for <application>Colord</application>.
191 </para>
192
193 <para>
194 <parameter>--enable-libcolordcompat</parameter>: This switch enables
195 building a compatibility library for older packages that use
196 <application>Colord</application>.
197 </para>
198
199 <para>
200 <parameter>--disable-rpath</parameter>: This switch prevents the build
201 process from hard-coding library paths into its executables.
202 </para>
203
204 <para>
205 <parameter>--disable-argyllcms-sensor</parameter>: This switch disables
206 the ArgLLCMS sensor driver. Omit if you have
207 <ulink url="http://www.argyllcms.com/">ArgLLCMS</ulink> installed
208 and wish to use it.
209 </para>
210
211 <para>
212 <parameter>--disable-bash-completion</parameter>: This switch disables
213 Bash Completion support for Colord applications.
214 </para>
215
216 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
217 href="../../xincludes/static-libraries.xml"/>
218
219 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
220 href="../../xincludes/gtk-doc-rebuild.xml"/>
221
222 <para>
223 <option>--disable-gusb</option>: Use this switch if you don't have
224 <application>libgusb</application> installed.
225 </para>
226
227 <para>
228 <option>--disable-udev</option>: Use this switch if you don't have
229 <application>libgudev</application> installed.
230 </para>
231
232 <para>
233 <option>--disable-polkit</option>: Use this switch if you don't have
234 <application>polkit</application> installed.
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-profile1">
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="colord1 cd-create-profile">
287 <primary sortas="b-cd-create-profile1">cd-create-profile</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="cd-fix-profile1">
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="colord1 cd-fix-profile">
299 <primary sortas="b-cd-fix-profile1">cd-fix-profile</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="cd-iccdump1">
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="colord1 cd-iccdump">
311 <primary sortas="b-cd-iccdump1">cd-iccdump</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="cd-it81">
317 <term><command>cd-it8</command></term>
318 <listitem>
319 <para>
320 is the Color Manager Testing Tool.
321 </para>
322 <indexterm zone="colord1 cd-it8">
323 <primary sortas="b-cd-it81">cd-it8</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="colormgr1">
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="colord1 colormgr">
336 <primary sortas="b-colormgr1">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="colord1 libcolord.so">
348 <primary sortas="c-libcolord.so1">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="colord1 libcolordcompat.so">
361 <primary sortas="c-libcolordcompat.so1">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="colord1 libcolordprivate.so">
374 <primary sortas="c-libcolordprivate.so1">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.so1">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.