[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 " ">
|
---|
[bf6bb90] | 9 | <!ENTITY colord-md5sum "f457be5b7c44827e6c747ec80a6dc69a">
|
---|
| 10 | <!ENTITY colord-size "1.8 MB">
|
---|
| 11 | <!ENTITY colord-buildsize "26 MB (with tests)">
|
---|
[1accff3c] | 12 | <!ENTITY colord-time "0.7 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 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[880c568] | 23 | <title>Colord-&colord-version;</title>
|
---|
[f1a8ab0] | 24 |
|
---|
| 25 | <indexterm zone="colord">
|
---|
[1accff3c] | 26 | <primary sortas="a-colord">Colord</primary>
|
---|
[f1a8ab0] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[7ded7e3] | 30 | <title>Introduction to Colord</title>
|
---|
[f1a8ab0] | 31 |
|
---|
[7ded7e3] | 32 | <para>
|
---|
[1accff3c] | 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
|
---|
[7ded7e3] | 35 | <application>GNOME Color Manager</application> for system integration
|
---|
[1accff3c] | 36 | and use when no users are logged in.
|
---|
[7ded7e3] | 37 | </para>
|
---|
[f1a8ab0] | 38 |
|
---|
[f81d69a2] | 39 | &lfs82_checked;
|
---|
[f1a8ab0] | 40 |
|
---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
[7ded7e3] | 44 | <para>
|
---|
| 45 | Download (HTTP): <ulink url="&colord-download-http;"/>
|
---|
| 46 | </para>
|
---|
[f1a8ab0] | 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
[7ded7e3] | 49 | <para>
|
---|
| 50 | Download (FTP): <ulink url="&colord-download-ftp;"/>
|
---|
| 51 | </para>
|
---|
[f1a8ab0] | 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
[7ded7e3] | 54 | <para>
|
---|
| 55 | Download MD5 sum: &colord-md5sum;
|
---|
| 56 | </para>
|
---|
[f1a8ab0] | 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[7ded7e3] | 59 | <para>
|
---|
| 60 | Download size: &colord-size;
|
---|
| 61 | </para>
|
---|
[f1a8ab0] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[7ded7e3] | 64 | <para>
|
---|
| 65 | Estimated disk space required: &colord-buildsize;
|
---|
| 66 | </para>
|
---|
[f1a8ab0] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[7ded7e3] | 69 | <para>
|
---|
| 70 | Estimated build time: &colord-time;
|
---|
| 71 | </para>
|
---|
[f1a8ab0] | 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
| 74 |
|
---|
[7ded7e3] | 75 | <bridgehead renderas="sect3">Colord Dependencies</bridgehead>
|
---|
[f1a8ab0] | 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[c341539] | 78 | <para role="required">
|
---|
[54666831] | 79 | <xref linkend="dbus"/>,
|
---|
[fa99d008] | 80 | <xref linkend="glib2"/>,
|
---|
[08de396] | 81 | <xref linkend="lcms2"/>, and
|
---|
| 82 | <xref linkend="sqlite"/>
|
---|
[c341539] | 83 | </para>
|
---|
| 84 |
|
---|
[7ded7e3] | 85 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[c341539] | 86 | <para role="recommended">
|
---|
[91e382cd] | 87 | <xref linkend="gobject-introspection"/>,
|
---|
[f175d6f6] | 88 | <xref linkend="libgudev"/>,
|
---|
[7d7588a3] | 89 | <xref linkend="libgusb"/>,
|
---|
[4d89757] | 90 | <xref linkend="polkit"/>, <phrase revision="sysv">and</phrase>
|
---|
| 91 | <phrase revision="systemd"><xref linkend="systemd"/>, and</phrase>
|
---|
[01996ebb] | 92 | <xref linkend="vala"/>
|
---|
[c341539] | 93 | </para>
|
---|
[f1a8ab0] | 94 |
|
---|
[7ded7e3] | 95 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c341539] | 96 | <para role="optional">
|
---|
[7d7588a3] | 97 | <xref linkend="docbook-utils"/>,
|
---|
[2249a59] | 98 | <xref linkend="gnome-desktop"/> and
|
---|
[6ec15f1f] | 99 | <xref linkend="colord-gtk"/> (to build the example tools),
|
---|
[c647e6d] | 100 | <xref linkend="gtk-doc"/>,
|
---|
[91e382cd] | 101 | <xref linkend="libxslt"/>,
|
---|
[2249a59] | 102 | <xref linkend="sane"/>,
|
---|
[6b7881d] | 103 | <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink>, and
|
---|
[1accff3c] | 104 | <ulink url="https://github.com/scop/bash-completion/">Bash Completion</ulink>
|
---|
[c341539] | 105 | </para>
|
---|
[f1a8ab0] | 106 |
|
---|
[1accff3c] | 107 | <para condition="html" role="usernotes">
|
---|
| 108 | User Notes: <ulink url="&blfs-wiki;/colord"/>
|
---|
[7ded7e3] | 109 | </para>
|
---|
[f1a8ab0] | 110 | </sect2>
|
---|
| 111 |
|
---|
| 112 | <sect2 role="installation">
|
---|
[7ded7e3] | 113 | <title>Installation of Colord</title>
|
---|
[f1a8ab0] | 114 |
|
---|
[d6da5da] | 115 | <para>
|
---|
[1accff3c] | 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
|
---|
[d6da5da] | 118 | <systemitem class="username">root</systemitem> user:
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
| 121 | <screen role="root"><userinput>groupadd -g 71 colord &&
|
---|
| 122 | useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
|
---|
| 123 | -g colord -s /bin/false colord</userinput></screen>
|
---|
| 124 |
|
---|
[7ded7e3] | 125 | <para>
|
---|
| 126 | Install <application>Colord</application> by running the following
|
---|
| 127 | commands:
|
---|
| 128 | </para>
|
---|
[f1a8ab0] | 129 |
|
---|
[bf6bb90] | 130 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
| 131 | cd build &&
|
---|
| 132 | meson --prefix=/usr \
|
---|
| 133 | --sysconfdir=/etc \
|
---|
| 134 | --localstatedir=/var \
|
---|
| 135 | -Dwith-daemon-user=colord \
|
---|
| 136 | -Denable-vala=true \
|
---|
| 137 | -Denable-systemd=false \
|
---|
[92a7200] | 138 | -Denable-libcolordcompat=true \
|
---|
[bf6bb90] | 139 | -Denable-argyllcms-sensor=false \
|
---|
| 140 | -Denable-bash-completion=false \
|
---|
| 141 | -Denable-docs=false \
|
---|
| 142 | -Denable-man=false .. &&
|
---|
| 143 | ninja</userinput></screen>
|
---|
| 144 |
|
---|
| 145 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
| 146 | cd build &&
|
---|
| 147 | meson --prefix=/usr \
|
---|
| 148 | --sysconfdir=/etc \
|
---|
| 149 | --localstatedir=/var \
|
---|
| 150 | -Dwith-daemon-user=colord \
|
---|
| 151 | -Denable-vala=true \
|
---|
| 152 | -Denable-systemd=true \
|
---|
[92a7200] | 153 | -Denable-libcolordcompat=true \
|
---|
[bf6bb90] | 154 | -Denable-argyllcms-sensor=false \
|
---|
| 155 | -Denable-bash-completion=false \
|
---|
| 156 | -Denable-docs=false \
|
---|
| 157 | -Denable-man=false .. &&
|
---|
| 158 | ninja</userinput></screen>
|
---|
[95381469] | 159 |
|
---|
[7ded7e3] | 160 | <para>
|
---|
| 161 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 162 | </para>
|
---|
[f1a8ab0] | 163 |
|
---|
[bf6bb90] | 164 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[f1a8ab0] | 165 |
|
---|
[d6da5da] | 166 | <para>
|
---|
[bf6bb90] | 167 | To test the results, issue: <command>ninja -k 2 test</command>.
|
---|
| 168 | One test, <filename>colord-self-test-daemon</filename>, will fail.
|
---|
[1accff3c] | 169 | The test suite must be run after the package is installed, and the
|
---|
| 170 | system-wide D-Bus Daemon must be running.
|
---|
[d6da5da] | 171 | </para>
|
---|
| 172 |
|
---|
[f1a8ab0] | 173 | </sect2>
|
---|
| 174 |
|
---|
| 175 | <sect2 role="commands">
|
---|
| 176 | <title>Command Explanations</title>
|
---|
| 177 |
|
---|
[28b61748] | 178 | <para>
|
---|
[bf6bb90] | 179 | <parameter>-Dwith-daemon-user=colord</parameter>: This switch is used
|
---|
[1accff3c] | 180 | so the colord daemon will run as an unprivileged user instead of the
|
---|
[d6da5da] | 181 | <systemitem class="username">root</systemitem> user.
|
---|
[28b61748] | 182 | </para>
|
---|
| 183 |
|
---|
| 184 | <para>
|
---|
[bf6bb90] | 185 | <parameter>-Denable-vala=true</parameter>: This switch enables building
|
---|
| 186 | the <application>Vala</application> bindings. Remove if you don't have
|
---|
[1accff3c] | 187 | <xref linkend="vala"/> installed.
|
---|
[28b61748] | 188 | </para>
|
---|
| 189 |
|
---|
[bf6bb90] | 190 | <para revision="sysv">
|
---|
| 191 | <parameter>-Denable-systemd=false</parameter>: This switch disables
|
---|
| 192 | support for <application>systemd</application> login in Colord
|
---|
| 193 | applications.
|
---|
[b194f2b] | 194 | </para>
|
---|
| 195 |
|
---|
[bf6bb90] | 196 | <para revision="systemd">
|
---|
| 197 | <parameter>-Denable-systemd=true</parameter>: This switch enables
|
---|
| 198 | installation of the <application>systemd</application> service.
|
---|
[82b5e658] | 199 | </para>
|
---|
| 200 |
|
---|
[03b4b3a] | 201 | <para>
|
---|
[bf6bb90] | 202 | <parameter>-Denable-libcolordcompat=true</parameter>: This switch enables
|
---|
[1accff3c] | 203 | building a compatibility library for older packages that use
|
---|
| 204 | <application>Colord</application>.
|
---|
[03b4b3a] | 205 | </para>
|
---|
[c647e6d] | 206 |
|
---|
[1accff3c] | 207 | <para>
|
---|
[bf6bb90] | 208 | <parameter>-Denable-argyllcms-sensor=false</parameter>: This switch
|
---|
| 209 | disables the ArgLLCMS sensor driver. Omit if you have
|
---|
[6b7881d] | 210 | <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
|
---|
[1accff3c] | 211 | and wish to use it.
|
---|
[2b872a2] | 212 | </para>
|
---|
| 213 |
|
---|
[2249a59] | 214 | <para>
|
---|
[bf6bb90] | 215 | <parameter>-Denable-bash-completion=false</parameter>: This switch
|
---|
| 216 | disables Bash Completion support for Colord applications.
|
---|
[fa99d008] | 217 | </para>
|
---|
| 218 |
|
---|
| 219 | <para>
|
---|
[bf6bb90] | 220 | <parameter>-Denable-docs=false</parameter>: This switch disables building
|
---|
| 221 | of documentation. Omit if you have <xref linkend="gtk-doc"/> avaialable.
|
---|
[fa99d008] | 222 | </para>
|
---|
| 223 |
|
---|
| 224 | <para>
|
---|
[bf6bb90] | 225 | <parameter>-Denable-man=false</parameter>: This switch disables building
|
---|
| 226 | of man pages. Omit if you have <xref linkend="docbook-utils"/>
|
---|
| 227 | avaialable.
|
---|
[fa99d008] | 228 | </para>
|
---|
| 229 |
|
---|
[f1a8ab0] | 230 | </sect2>
|
---|
| 231 |
|
---|
| 232 | <sect2 role="content">
|
---|
| 233 | <title>Contents</title>
|
---|
| 234 |
|
---|
| 235 | <segmentedlist>
|
---|
| 236 | <segtitle>Installed Programs</segtitle>
|
---|
[d6da5da] | 237 | <segtitle>Installed Libraries</segtitle>
|
---|
[f1a8ab0] | 238 | <segtitle>Installed Directories</segtitle>
|
---|
| 239 |
|
---|
| 240 | <seglistitem>
|
---|
[c341539] | 241 | <seg>
|
---|
[1accff3c] | 242 | cd-create-profile,
|
---|
| 243 | cd-fix-profile,
|
---|
| 244 | cd-iccdump,
|
---|
| 245 | cd-it8, and
|
---|
| 246 | colormgr
|
---|
[c341539] | 247 | </seg>
|
---|
| 248 | <seg>
|
---|
[1accff3c] | 249 | libcolord.so,
|
---|
| 250 | libcolordcompat.so,
|
---|
| 251 | libcolordprivate.so, and
|
---|
| 252 | libcolorhug.so
|
---|
[c341539] | 253 | </seg>
|
---|
| 254 | <seg>
|
---|
[7ded7e3] | 255 | /usr/include/colord-1,
|
---|
[7d7588a3] | 256 | /usr/lib/colord-{plugins,sensors},
|
---|
[1accff3c] | 257 | /usr/share/color{d},
|
---|
[7d7588a3] | 258 | /usr/share/gtk-doc/html/colord, and
|
---|
[c341539] | 259 | /var/lib/colord
|
---|
| 260 | </seg>
|
---|
[f1a8ab0] | 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 |
|
---|
[1accff3c] | 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 |
|
---|
[f1a8ab0] | 273 | <varlistentry id="cd-create-profile">
|
---|
| 274 | <term><command>cd-create-profile</command></term>
|
---|
| 275 | <listitem>
|
---|
[7ded7e3] | 276 | <para>
|
---|
[1accff3c] | 277 | is the Color Manager Profile Creation Tool.
|
---|
[7ded7e3] | 278 | </para>
|
---|
[f1a8ab0] | 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>
|
---|
[7ded7e3] | 288 | <para>
|
---|
| 289 | is a tool used to fix metadata in ICC profiles.
|
---|
| 290 | </para>
|
---|
[f1a8ab0] | 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 |
|
---|
[7d7588a3] | 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 |
|
---|
[06a322f] | 309 | <varlistentry id="cd-it8">
|
---|
| 310 | <term><command>cd-it8</command></term>
|
---|
| 311 | <listitem>
|
---|
| 312 | <para>
|
---|
[1accff3c] | 313 | is the Color Manager Testing Tool.
|
---|
[06a322f] | 314 | </para>
|
---|
| 315 | <indexterm zone="colord cd-it8">
|
---|
| 316 | <primary sortas="b-cd-it8">cd-it8</primary>
|
---|
| 317 | </indexterm>
|
---|
| 318 | </listitem>
|
---|
| 319 | </varlistentry>
|
---|
| 320 |
|
---|
[f1a8ab0] | 321 | <varlistentry id="colormgr">
|
---|
| 322 | <term><command>colormgr</command></term>
|
---|
| 323 | <listitem>
|
---|
[7ded7e3] | 324 | <para>
|
---|
[1accff3c] | 325 | is a text-mode program that allows you to interact with colord on
|
---|
| 326 | the command line.
|
---|
[7ded7e3] | 327 | </para>
|
---|
[f1a8ab0] | 328 | <indexterm zone="colord colormgr">
|
---|
| 329 | <primary sortas="b-colormgr">colormgr</primary>
|
---|
| 330 | </indexterm>
|
---|
| 331 | </listitem>
|
---|
| 332 | </varlistentry>
|
---|
| 333 |
|
---|
[1accff3c] | 334 | <varlistentry id="libcolord.so">
|
---|
[c8f8332] | 335 | <term><filename class="libraryfile">libcolord.so</filename></term>
|
---|
[f1a8ab0] | 336 | <listitem>
|
---|
[7ded7e3] | 337 | <para>
|
---|
| 338 | contains the <application>Colord</application> API functions.
|
---|
| 339 | </para>
|
---|
[1accff3c] | 340 | <indexterm zone="colord libcolord.so">
|
---|
| 341 | <primary sortas="c-libcolord.so">libcolord.so</primary>
|
---|
[f1a8ab0] | 342 | </indexterm>
|
---|
| 343 | </listitem>
|
---|
| 344 | </varlistentry>
|
---|
| 345 |
|
---|
[1accff3c] | 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>
|
---|
[f1a8ab0] | 358 |
|
---|
[1accff3c] | 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>
|
---|
[f1a8ab0] | 371 |
|
---|
[1accff3c] | 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>
|
---|
[f1a8ab0] | 385 | </sect1>
|
---|