source: archive/colord.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

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