source: general/sysutils/colord.xml@ 45ab6c7

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