[f1a8ab0] | 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 |
|
---|
[1accff3c] | 7 | <!ENTITY colord-download-http "https://www.freedesktop.org/software/colord/releases/colord-&colord-version;.tar.xz">
|
---|
[f1a8ab0] | 8 | <!ENTITY colord-download-ftp " ">
|
---|
[519aed4] | 9 | <!ENTITY colord-md5sum "7dbdc807495890c13e8242385f4c641f">
|
---|
[bf6bb90] | 10 | <!ENTITY colord-size "1.8 MB">
|
---|
[519aed4] | 11 | <!ENTITY colord-buildsize "32 MB (with tests)">
|
---|
[6b64a918] | 12 | <!ENTITY colord-time "0.3 SBU (with tests)">
|
---|
[f1a8ab0] | 13 | ]>
|
---|
| 14 |
|
---|
[4d89757] | 15 | <sect1 id="colord" xreflabel="colord-&colord-version;">
|
---|
[f1a8ab0] | 16 | <?dbhtml filename="colord.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
[880c568] | 22 | <title>Colord-&colord-version;</title>
|
---|
[f1a8ab0] | 23 |
|
---|
| 24 | <indexterm zone="colord">
|
---|
[1accff3c] | 25 | <primary sortas="a-colord">Colord</primary>
|
---|
[f1a8ab0] | 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
[7ded7e3] | 29 | <title>Introduction to Colord</title>
|
---|
[f1a8ab0] | 30 |
|
---|
[7ded7e3] | 31 | <para>
|
---|
[1accff3c] | 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
|
---|
[7ded7e3] | 34 | <application>GNOME Color Manager</application> for system integration
|
---|
[1accff3c] | 35 | and use when no users are logged in.
|
---|
[7ded7e3] | 36 | </para>
|
---|
[f1a8ab0] | 37 |
|
---|
[519aed4] | 38 | &lfs111_checked;
|
---|
[f1a8ab0] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[7ded7e3] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&colord-download-http;"/>
|
---|
| 45 | </para>
|
---|
[f1a8ab0] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[7ded7e3] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&colord-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[f1a8ab0] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[7ded7e3] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &colord-md5sum;
|
---|
| 55 | </para>
|
---|
[f1a8ab0] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[7ded7e3] | 58 | <para>
|
---|
| 59 | Download size: &colord-size;
|
---|
| 60 | </para>
|
---|
[f1a8ab0] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[7ded7e3] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &colord-buildsize;
|
---|
| 65 | </para>
|
---|
[f1a8ab0] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[7ded7e3] | 68 | <para>
|
---|
| 69 | Estimated build time: &colord-time;
|
---|
| 70 | </para>
|
---|
[f1a8ab0] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
[7ded7e3] | 74 | <bridgehead renderas="sect3">Colord Dependencies</bridgehead>
|
---|
[f1a8ab0] | 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[c341539] | 77 | <para role="required">
|
---|
[54666831] | 78 | <xref linkend="dbus"/>,
|
---|
[fa99d008] | 79 | <xref linkend="glib2"/>,
|
---|
[106ed2ba] | 80 | <xref linkend="lcms2"/>,
|
---|
| 81 | <xref linkend="polkit"/>, and
|
---|
| 82 | <!-- Polkit now needed, see #11481 in Trac -->
|
---|
[08de396] | 83 | <xref linkend="sqlite"/>
|
---|
[c341539] | 84 | </para>
|
---|
| 85 |
|
---|
[7ded7e3] | 86 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[c341539] | 87 | <para role="recommended">
|
---|
[91e382cd] | 88 | <xref linkend="gobject-introspection"/>,
|
---|
[f175d6f6] | 89 | <xref linkend="libgudev"/>,
|
---|
[7d7588a3] | 90 | <xref linkend="libgusb"/>,
|
---|
[106ed2ba] | 91 | <phrase revision="sysv">and</phrase>
|
---|
[4d89757] | 92 | <phrase revision="systemd"><xref linkend="systemd"/>, and</phrase>
|
---|
[01996ebb] | 93 | <xref linkend="vala"/>
|
---|
[c341539] | 94 | </para>
|
---|
[f1a8ab0] | 95 |
|
---|
[7ded7e3] | 96 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c341539] | 97 | <para role="optional">
|
---|
[2249a59] | 98 | <xref linkend="gnome-desktop"/> and
|
---|
[6ec15f1f] | 99 | <xref linkend="colord-gtk"/> (to build the example tools),
|
---|
[dd51538] | 100 | <xref linkend="docbook-utils"/>,
|
---|
| 101 | <xref linkend="gtk-doc"/>,
|
---|
[91e382cd] | 102 | <xref linkend="libxslt"/>,
|
---|
[2249a59] | 103 | <xref linkend="sane"/>,
|
---|
[6b7881d] | 104 | <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink>, and
|
---|
[1accff3c] | 105 | <ulink url="https://github.com/scop/bash-completion/">Bash Completion</ulink>
|
---|
[c341539] | 106 | </para>
|
---|
[f1a8ab0] | 107 |
|
---|
[1accff3c] | 108 | <para condition="html" role="usernotes">
|
---|
| 109 | User Notes: <ulink url="&blfs-wiki;/colord"/>
|
---|
[7ded7e3] | 110 | </para>
|
---|
[f1a8ab0] | 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | <sect2 role="installation">
|
---|
[7ded7e3] | 114 | <title>Installation of Colord</title>
|
---|
[f1a8ab0] | 115 |
|
---|
[d6da5da] | 116 | <para>
|
---|
[1accff3c] | 117 | There should be a dedicated user and group to take control of the colord
|
---|
| 118 | daemon after it has started. Issue the following commands as the
|
---|
[d6da5da] | 119 | <systemitem class="username">root</systemitem> user:
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <screen role="root"><userinput>groupadd -g 71 colord &&
|
---|
| 123 | useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
|
---|
| 124 | -g colord -s /bin/false colord</userinput></screen>
|
---|
| 125 |
|
---|
[7ded7e3] | 126 | <para>
|
---|
| 127 | Install <application>Colord</application> by running the following
|
---|
| 128 | commands:
|
---|
| 129 | </para>
|
---|
[f1a8ab0] | 130 |
|
---|
[bf6bb90] | 131 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
[f858bd7] | 132 | cd build &&
|
---|
| 133 |
|
---|
[2f59d11] | 134 | meson --prefix=/usr \
|
---|
[20f070d8] | 135 | --buildtype=release \
|
---|
[2f59d11] | 136 | -Ddaemon_user=colord \
|
---|
| 137 | -Dvapi=true \
|
---|
| 138 | -Dsystemd=false \
|
---|
| 139 | -Dlibcolordcompat=true \
|
---|
| 140 | -Dargyllcms_sensor=false \
|
---|
| 141 | -Dbash_completion=false \
|
---|
| 142 | -Ddocs=false \
|
---|
| 143 | -Dman=false .. &&
|
---|
[bf6bb90] | 144 | ninja</userinput></screen>
|
---|
| 145 |
|
---|
| 146 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
| 147 | cd build &&
|
---|
[2f59d11] | 148 |
|
---|
| 149 | meson --prefix=/usr \
|
---|
[20f070d8] | 150 | --buildtype=release \
|
---|
[2f59d11] | 151 | -Ddaemon_user=colord \
|
---|
| 152 | -Dvapi=true \
|
---|
| 153 | -Dsystemd=true \
|
---|
| 154 | -Dlibcolordcompat=true \
|
---|
| 155 | -Dargyllcms_sensor=false \
|
---|
| 156 | -Dbash_completion=false \
|
---|
| 157 | -Ddocs=false \
|
---|
| 158 | -Dman=false .. &&
|
---|
[bf6bb90] | 159 | ninja</userinput></screen>
|
---|
[95381469] | 160 |
|
---|
[7ded7e3] | 161 | <para>
|
---|
| 162 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 163 | </para>
|
---|
[f1a8ab0] | 164 |
|
---|
[bf6bb90] | 165 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[f1a8ab0] | 166 |
|
---|
[d6da5da] | 167 | <para>
|
---|
[bf6bb90] | 168 | To test the results, issue: <command>ninja -k 2 test</command>.
|
---|
| 169 | One test, <filename>colord-self-test-daemon</filename>, will fail.
|
---|
[1accff3c] | 170 | The test suite must be run after the package is installed, and the
|
---|
| 171 | system-wide D-Bus Daemon must be running.
|
---|
[d6da5da] | 172 | </para>
|
---|
| 173 |
|
---|
[f1a8ab0] | 174 | </sect2>
|
---|
| 175 |
|
---|
| 176 | <sect2 role="commands">
|
---|
| 177 | <title>Command Explanations</title>
|
---|
| 178 |
|
---|
[20f070d8] | 179 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 180 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 181 |
|
---|
[28b61748] | 182 | <para>
|
---|
[2f59d11] | 183 | <parameter>-Ddaemon_user=colord</parameter>: This switch is used
|
---|
[1accff3c] | 184 | so the colord daemon will run as an unprivileged user instead of the
|
---|
[d6da5da] | 185 | <systemitem class="username">root</systemitem> user.
|
---|
[28b61748] | 186 | </para>
|
---|
| 187 |
|
---|
| 188 | <para>
|
---|
[2f59d11] | 189 | <parameter>-Dvapi=true</parameter>: This switch enables building
|
---|
[bf6bb90] | 190 | the <application>Vala</application> bindings. Remove if you don't have
|
---|
[1accff3c] | 191 | <xref linkend="vala"/> installed.
|
---|
[28b61748] | 192 | </para>
|
---|
| 193 |
|
---|
[bf6bb90] | 194 | <para revision="sysv">
|
---|
[2f59d11] | 195 | <parameter>-Dsystemd=false</parameter>: This switch disables
|
---|
[bf6bb90] | 196 | support for <application>systemd</application> login in Colord
|
---|
[8558044] | 197 | applications.
|
---|
[b194f2b] | 198 | </para>
|
---|
| 199 |
|
---|
[bf6bb90] | 200 | <para revision="systemd">
|
---|
[2f59d11] | 201 | <parameter>-Dsystemd=true</parameter>: This switch enables
|
---|
[bf6bb90] | 202 | installation of the <application>systemd</application> service.
|
---|
[82b5e658] | 203 | </para>
|
---|
| 204 |
|
---|
[03b4b3a] | 205 | <para>
|
---|
[2f59d11] | 206 | <parameter>-Dlibcolordcompat=true</parameter>: This switch enables
|
---|
[1accff3c] | 207 | building a compatibility library for older packages that use
|
---|
| 208 | <application>Colord</application>.
|
---|
[03b4b3a] | 209 | </para>
|
---|
[c647e6d] | 210 |
|
---|
[1accff3c] | 211 | <para>
|
---|
[2f59d11] | 212 | <parameter>-Dargyllcms_sensor=false</parameter>: This switch
|
---|
[bf6bb90] | 213 | disables the ArgLLCMS sensor driver. Omit if you have
|
---|
[6b7881d] | 214 | <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
|
---|
[1accff3c] | 215 | and wish to use it.
|
---|
[2b872a2] | 216 | </para>
|
---|
| 217 |
|
---|
[2249a59] | 218 | <para>
|
---|
[2f59d11] | 219 | <parameter>-Dbash_completion=false</parameter>: This switch
|
---|
[bf6bb90] | 220 | disables Bash Completion support for Colord applications.
|
---|
[fa99d008] | 221 | </para>
|
---|
| 222 |
|
---|
| 223 | <para>
|
---|
[2f59d11] | 224 | <parameter>-Ddocs=false</parameter>: This switch disables building
|
---|
[c250033] | 225 | of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
|
---|
[fa99d008] | 226 | </para>
|
---|
| 227 |
|
---|
| 228 | <para>
|
---|
[2f59d11] | 229 | <parameter>-Dman=false</parameter>: This switch disables building
|
---|
[bf6bb90] | 230 | of man pages. Omit if you have <xref linkend="docbook-utils"/>
|
---|
[c250033] | 231 | available. Namespaced versions of the docbook-xsl stylesheets
|
---|
[4855935] | 232 | are also required.
|
---|
[fa99d008] | 233 | </para>
|
---|
| 234 |
|
---|
[f1a8ab0] | 235 | </sect2>
|
---|
| 236 |
|
---|
| 237 | <sect2 role="content">
|
---|
| 238 | <title>Contents</title>
|
---|
| 239 |
|
---|
| 240 | <segmentedlist>
|
---|
| 241 | <segtitle>Installed Programs</segtitle>
|
---|
[d6da5da] | 242 | <segtitle>Installed Libraries</segtitle>
|
---|
[f1a8ab0] | 243 | <segtitle>Installed Directories</segtitle>
|
---|
| 244 |
|
---|
| 245 | <seglistitem>
|
---|
[c341539] | 246 | <seg>
|
---|
[1accff3c] | 247 | cd-create-profile,
|
---|
| 248 | cd-fix-profile,
|
---|
| 249 | cd-iccdump,
|
---|
| 250 | cd-it8, and
|
---|
| 251 | colormgr
|
---|
[c341539] | 252 | </seg>
|
---|
| 253 | <seg>
|
---|
[1accff3c] | 254 | libcolord.so,
|
---|
| 255 | libcolordcompat.so,
|
---|
| 256 | libcolordprivate.so, and
|
---|
| 257 | libcolorhug.so
|
---|
[c341539] | 258 | </seg>
|
---|
| 259 | <seg>
|
---|
[7ded7e3] | 260 | /usr/include/colord-1,
|
---|
[7d7588a3] | 261 | /usr/lib/colord-{plugins,sensors},
|
---|
[1accff3c] | 262 | /usr/share/color{d},
|
---|
[7d7588a3] | 263 | /usr/share/gtk-doc/html/colord, and
|
---|
[c341539] | 264 | /var/lib/colord
|
---|
| 265 | </seg>
|
---|
[f1a8ab0] | 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 |
|
---|
[1accff3c] | 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 |
|
---|
[f1a8ab0] | 278 | <varlistentry id="cd-create-profile">
|
---|
| 279 | <term><command>cd-create-profile</command></term>
|
---|
| 280 | <listitem>
|
---|
[7ded7e3] | 281 | <para>
|
---|
[4c24eb0a] | 282 | is the Color Manager Profile Creation Tool
|
---|
[7ded7e3] | 283 | </para>
|
---|
[f1a8ab0] | 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>
|
---|
[7ded7e3] | 293 | <para>
|
---|
[4c24eb0a] | 294 | is a tool used to fix metadata in ICC profiles
|
---|
[7ded7e3] | 295 | </para>
|
---|
[f1a8ab0] | 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 |
|
---|
[7d7588a3] | 302 | <varlistentry id="cd-iccdump">
|
---|
| 303 | <term><command>cd-iccdump</command></term>
|
---|
| 304 | <listitem>
|
---|
| 305 | <para>
|
---|
[4c24eb0a] | 306 | dumps the contents of an ICC profile as human readable text
|
---|
[7d7588a3] | 307 | </para>
|
---|
| 308 | <indexterm zone="colord cd-iccdump">
|
---|
| 309 | <primary sortas="b-cd-iccdump">cd-iccdump</primary>
|
---|
| 310 | </indexterm>
|
---|
| 311 | </listitem>
|
---|
| 312 | </varlistentry>
|
---|
| 313 |
|
---|
[06a322f] | 314 | <varlistentry id="cd-it8">
|
---|
| 315 | <term><command>cd-it8</command></term>
|
---|
| 316 | <listitem>
|
---|
| 317 | <para>
|
---|
[4c24eb0a] | 318 | is the Color Manager Testing Tool
|
---|
[06a322f] | 319 | </para>
|
---|
| 320 | <indexterm zone="colord cd-it8">
|
---|
| 321 | <primary sortas="b-cd-it8">cd-it8</primary>
|
---|
| 322 | </indexterm>
|
---|
| 323 | </listitem>
|
---|
| 324 | </varlistentry>
|
---|
| 325 |
|
---|
[f1a8ab0] | 326 | <varlistentry id="colormgr">
|
---|
| 327 | <term><command>colormgr</command></term>
|
---|
| 328 | <listitem>
|
---|
[7ded7e3] | 329 | <para>
|
---|
[1accff3c] | 330 | is a text-mode program that allows you to interact with colord on
|
---|
[4c24eb0a] | 331 | the command line
|
---|
[7ded7e3] | 332 | </para>
|
---|
[f1a8ab0] | 333 | <indexterm zone="colord colormgr">
|
---|
| 334 | <primary sortas="b-colormgr">colormgr</primary>
|
---|
| 335 | </indexterm>
|
---|
| 336 | </listitem>
|
---|
| 337 | </varlistentry>
|
---|
| 338 |
|
---|
[1accff3c] | 339 | <varlistentry id="libcolord.so">
|
---|
[c8f8332] | 340 | <term><filename class="libraryfile">libcolord.so</filename></term>
|
---|
[f1a8ab0] | 341 | <listitem>
|
---|
[7ded7e3] | 342 | <para>
|
---|
[4c24eb0a] | 343 | contains the <application>Colord</application> API functions
|
---|
[7ded7e3] | 344 | </para>
|
---|
[1accff3c] | 345 | <indexterm zone="colord libcolord.so">
|
---|
| 346 | <primary sortas="c-libcolord.so">libcolord.so</primary>
|
---|
[f1a8ab0] | 347 | </indexterm>
|
---|
| 348 | </listitem>
|
---|
| 349 | </varlistentry>
|
---|
| 350 |
|
---|
[1accff3c] | 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
|
---|
[4c24eb0a] | 356 | applications
|
---|
[1accff3c] | 357 | </para>
|
---|
| 358 | <indexterm zone="colord libcolordcompat.so">
|
---|
| 359 | <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
|
---|
| 360 | </indexterm>
|
---|
| 361 | </listitem>
|
---|
| 362 | </varlistentry>
|
---|
[f1a8ab0] | 363 |
|
---|
[1accff3c] | 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
|
---|
[4c24eb0a] | 369 | <application>Colord</application>
|
---|
[1accff3c] | 370 | </para>
|
---|
| 371 | <indexterm zone="colord libcolordprivate.so">
|
---|
| 372 | <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
|
---|
| 373 | </indexterm>
|
---|
| 374 | </listitem>
|
---|
| 375 | </varlistentry>
|
---|
[f1a8ab0] | 376 |
|
---|
[1accff3c] | 377 | <varlistentry id="libcolorhug.so">
|
---|
| 378 | <term><filename class="libraryfile">libcolorhug.so</filename></term>
|
---|
| 379 | <listitem>
|
---|
| 380 | <para>
|
---|
[4c24eb0a] | 381 | contains a simple display hardware colorimiter
|
---|
[1accff3c] | 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>
|
---|
[4c24eb0a] | 390 |
|
---|
[f1a8ab0] | 391 | </sect1>
|
---|