source: archive/colord.xml

trunk
Last change on this file was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 10.6 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
8 "https://www.freedesktop.org/software/colord/releases/colord-&colord-version;.tar.xz">
9 <!ENTITY colord-download-ftp " ">
10 <!ENTITY colord-md5sum "80b106ba18a43c7eeaf2d9a2b8c5725b">
11 <!ENTITY colord-size "1.2 MB">
12 <!ENTITY colord-buildsize "37 MB (without tests)">
13 <!ENTITY colord-time "0.4 SBU (without tests)">
14]>
15
16<sect1 id="colord" xreflabel="Colord-&colord-version;">
17 <?dbhtml filename="colord.html"?>
18
19 <sect1info>
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 activated daemon that
34 maps devices to color profiles. It is used by
35 <application>GNOME Color Manager</application> for system integration
36 and use when there are no users 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">Required (for the tests)</bridgehead>
86 <para role="required">
87 <xref linkend="valgrind"/>
88 </para>
89
90 <bridgehead renderas="sect4">Recommended</bridgehead>
91 <para role="recommended">
92 <xref linkend="gobject-introspection"/>,
93 <xref linkend="libgudev"/>,
94 <xref linkend="libgusb"/>,
95 <xref linkend="polkit"/>,<phrase revision="sysv"> and</phrase>
96 <phrase revision="systemd"><xref linkend="systemd"/>, and</phrase>
97 <xref linkend="vala"/>
98 </para>
99
100 <bridgehead renderas="sect4">Optional</bridgehead>
101 <para role="optional">
102 <xref linkend="docbook-utils"/>,
103 <xref linkend="gnome-desktop"/> and
104 <xref linkend="colord-gtk"/> (to build the example tools),
105 <xref linkend="gtk-doc"/>,
106 <xref linkend="libxslt"/>,
107 <xref linkend="sane"/>,
108 <ulink url="http://www.argyllcms.com/">ArgllCMS</ulink>, and
109 <ulink url="http://bash-completion.alioth.debian.org/">Bash Completion</ulink>,
110 </para>
111
112 <para condition="html" role="usernotes">User Notes:
113 <ulink url="&blfs-wiki;/colord"/>
114 </para>
115 </sect2>
116
117 <sect2 role="installation">
118 <title>Installation of Colord</title>
119
120 <para>
121 There should be a dedicated user and group to take control
122 of the <command>colord</command> daemon after it is started.
123 Issue the following commands as the
124 <systemitem class="username">root</systemitem> user:
125 </para>
126
127<screen role="root"><userinput>groupadd -g 71 colord &amp;&amp;
128useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
129 -g colord -s /bin/false colord</userinput></screen>
130
131 <para>
132 Install <application>Colord</application> by running the following
133 commands:
134 </para>
135
136<screen revision="sysv"><userinput>./configure --prefix=/usr \
137 --sysconfdir=/etc \
138 --localstatedir=/var \
139 --with-daemon-user=colord \
140 --enable-vala \
141 --enable-systemd-login=no \
142 --disable-argyllcms-sensor \
143 --disable-bash-completion \
144 --disable-static \
145 --with-systemdsystemunitdir=no &amp;&amp;
146make</userinput></screen>
147
148<screen revision="systemd"><userinput>./configure --prefix=/usr \
149 --sysconfdir=/etc \
150 --localstatedir=/var \
151 --with-daemon-user=colord \
152 --enable-vala \
153 --disable-argyllcms-sensor \
154 --disable-bash-completion \
155 --disable-static &amp;&amp;
156make</userinput></screen>
157
158 <para>
159 Now, as the <systemitem class="username">root</systemitem> user:
160 </para>
161
162<screen role="root"><userinput>make install</userinput></screen>
163
164 <para>
165 To test the results, issue: <command>make -k check</command>. For unknown
166 reasons, some tests may fail. Note that the system-wide
167 <application>D-Bus</application> daemon must be running or the tests
168 will fail.
169 </para>
170
171 </sect2>
172
173 <sect2 role="commands">
174 <title>Command Explanations</title>
175
176 <para>
177 <parameter>--with-daemon-user=colord</parameter>: This
178 switch is used so the <command>colord</command> daemon
179 will run as an unprivileged user instead of
180 <systemitem class="username">root</systemitem> user.
181 </para>
182
183 <para>
184 <parameter>--enable-vala</parameter>: This switch enables
185 building of the Vala bindings. Remove if you don't
186 have <xref linkend="vala"/> installed.
187 </para>
188
189 <para revision="sysv">
190 <parameter>--enable-systemd-login=no</parameter>: This parameter fixes
191 building without <application>systemd</application>, which is not part
192 of LFS/BLFS. If you use <application>systemd</application>,
193 replace "no" by "yes".
194 </para>
195
196 <para>
197 <parameter>--disable-argyllcms-sensor</parameter>: Disables <ulink
198 url="http://www.argyllcms.com/">ArgllCMS</ulink> sensor driver.
199 </para>
200
201 <para>
202 <parameter>--disable-bash-completion</parameter>: This switch
203 disables <application>Bash Completion</application>
204 support for <application>Colord</application> apps.
205 </para>
206
207 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
208 href="../../xincludes/static-libraries.xml"/>
209
210 <para revision="sysv">
211 <parameter>--with-systemdsystemunitdir=no</parameter>: Disables
212 attempting to build with systemd libraries.
213 </para>
214
215 <para>
216 <option>--enable-gtk-doc</option>: Use this switch if
217 <application>GTK-Doc</application> is installed and you wish to build
218 and install the API documentation.
219 </para>
220
221 <para>
222 <option>--disable-gusb</option>: Use this switch if you don't have
223 <application>libgusb</application> installed.
224 </para>
225
226 <para>
227 <option>--disable-udev</option>: Use this switch if you don't have GUdev
228 installed.
229 </para>
230
231 <para>
232 <option>--disable-polkit</option>: Use this switch if you don't have
233 <application>Polkit</application> installed.
234 </para>
235
236 </sect2>
237
238 <sect2 role="content">
239 <title>Contents</title>
240
241 <segmentedlist>
242 <segtitle>Installed Programs</segtitle>
243 <segtitle>Installed Libraries</segtitle>
244 <segtitle>Installed Directories</segtitle>
245
246 <seglistitem>
247 <seg>
248 cd-create-profile, cd-fix-profile, cd-iccdump, cd-it8, and colormgr
249 </seg>
250 <seg>
251 libcolord.so, libcolordprivate.so, and libcolorhug.so
252 </seg>
253 <seg>
254 /usr/include/colord-1,
255 /usr/lib/colord-{plugins,sensors},
256 /usr/share/color{,d},
257 /usr/share/gtk-doc/html/colord, and
258 /var/lib/colord
259 </seg>
260 </seglistitem>
261 </segmentedlist>
262
263 <variablelist>
264 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
265 <?dbfo list-presentation="list"?>
266 <?dbhtml list-presentation="table"?>
267
268 <varlistentry id="cd-create-profile">
269 <term><command>cd-create-profile</command></term>
270 <listitem>
271 <para>
272 is a Color Manager Profile Creation Tool.
273 </para>
274 <indexterm zone="colord cd-create-profile">
275 <primary sortas="b-cd-create-profile">cd-create-profile</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="cd-fix-profile">
281 <term><command>cd-fix-profile</command></term>
282 <listitem>
283 <para>
284 is a tool used to fix metadata in ICC profiles.
285 </para>
286 <indexterm zone="colord cd-fix-profile">
287 <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="cd-iccdump">
293 <term><command>cd-iccdump</command></term>
294 <listitem>
295 <para>
296 dumps the contents of an ICC profile as human readable text.
297 </para>
298 <indexterm zone="colord cd-iccdump">
299 <primary sortas="b-cd-iccdump">cd-iccdump</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="cd-it8">
305 <term><command>cd-it8</command></term>
306 <listitem>
307 <para>
308 is a Color Manager Testing Tool.
309 </para>
310 <indexterm zone="colord cd-it8">
311 <primary sortas="b-cd-it8">cd-it8</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="colormgr">
317 <term><command>colormgr</command></term>
318 <listitem>
319 <para>
320 is a text-mode program that allows you to interact with colord
321 on the command line.
322 </para>
323 <indexterm zone="colord colormgr">
324 <primary sortas="b-colormgr">colormgr</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="libcolord">
330 <term><filename class="libraryfile">libcolord.so</filename></term>
331 <listitem>
332 <para>
333 contains the <application>Colord</application> API functions.
334 </para>
335 <indexterm zone="colord libcolord">
336 <primary sortas="c-libcolord">libcolord.so</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 </variablelist>
342
343 </sect2>
344
345</sect1>
Note: See TracBrowser for help on using the repository browser.