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