source: general/sysutils/colord.xml@ 0366f7d

10.0 10.1 11.0 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 0366f7d was 0366f7d, checked in by Douglas R. Reno <renodr@…>, 4 years ago

Fix colord page for real

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