[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 |
|
---|
[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 |
|
---|
[30c1c72] | 35 | &lfs120_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 |
|
---|
[7ded7e3] | 71 | <bridgehead renderas="sect3">Colord Dependencies</bridgehead>
|
---|
[f1a8ab0] | 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[c341539] | 74 | <para role="required">
|
---|
[54666831] | 75 | <xref linkend="dbus"/>,
|
---|
[fa99d008] | 76 | <xref linkend="glib2"/>,
|
---|
[106ed2ba] | 77 | <xref linkend="lcms2"/>,
|
---|
| 78 | <xref linkend="polkit"/>, and
|
---|
| 79 | <!-- Polkit now needed, see #11481 in Trac -->
|
---|
[08de396] | 80 | <xref linkend="sqlite"/>
|
---|
[c341539] | 81 | </para>
|
---|
| 82 |
|
---|
[7ded7e3] | 83 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[c341539] | 84 | <para role="recommended">
|
---|
[b125bbf] | 85 | <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
|
---|
[91e382cd] | 86 | <xref linkend="gobject-introspection"/>,
|
---|
[f175d6f6] | 87 | <xref linkend="libgudev"/>,
|
---|
[7d7588a3] | 88 | <xref linkend="libgusb"/>,
|
---|
[b125bbf] | 89 | <phrase revision="systemd" role="runtime"><xref linkend="systemd"/>
|
---|
| 90 | (runtime),</phrase>
|
---|
| 91 | and <xref linkend="vala"/>
|
---|
[c341539] | 92 | </para>
|
---|
[f1a8ab0] | 93 |
|
---|
[7ded7e3] | 94 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c341539] | 95 | <para role="optional">
|
---|
[2249a59] | 96 | <xref linkend="gnome-desktop"/> and
|
---|
[6ec15f1f] | 97 | <xref linkend="colord-gtk"/> (to build the example tools),
|
---|
[dd51538] | 98 | <xref linkend="docbook-utils"/>,
|
---|
| 99 | <xref linkend="gtk-doc"/>,
|
---|
[91e382cd] | 100 | <xref linkend="libxslt"/>,
|
---|
[2249a59] | 101 | <xref linkend="sane"/>,
|
---|
[6e2eb5cf] | 102 | <ulink url="https://www.argyllcms.com/">ArgyllCMS</ulink>, and
|
---|
[1accff3c] | 103 | <ulink url="https://github.com/scop/bash-completion/">Bash Completion</ulink>
|
---|
[c341539] | 104 | </para>
|
---|
[f1a8ab0] | 105 |
|
---|
| 106 | </sect2>
|
---|
| 107 |
|
---|
| 108 | <sect2 role="installation">
|
---|
[7ded7e3] | 109 | <title>Installation of Colord</title>
|
---|
[f1a8ab0] | 110 |
|
---|
[d6da5da] | 111 | <para>
|
---|
[1accff3c] | 112 | There should be a dedicated user and group to take control of the colord
|
---|
| 113 | daemon after it has started. Issue the following commands as the
|
---|
[d6da5da] | 114 | <systemitem class="username">root</systemitem> user:
|
---|
| 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <screen role="root"><userinput>groupadd -g 71 colord &&
|
---|
| 118 | useradd -c "Color Daemon Owner" -d /var/lib/colord -u 71 \
|
---|
| 119 | -g colord -s /bin/false colord</userinput></screen>
|
---|
| 120 |
|
---|
[7844a4a] | 121 | <!-- https://github.com/hughsie/colord/pull/146 -->
|
---|
| 122 | <para>
|
---|
| 123 | Fix a double free causing a build failure on 32-bit x86 and runtime
|
---|
| 124 | crashes with some monitors:
|
---|
| 125 | </para>
|
---|
| 126 |
|
---|
| 127 | <screen><userinput>sed '/cmsUnregisterPluginsTHR/d' -i lib/colord/cd-context-lcms.c</userinput></screen>
|
---|
| 128 |
|
---|
[7ded7e3] | 129 | <para>
|
---|
| 130 | Install <application>Colord</application> by running the following
|
---|
| 131 | commands:
|
---|
| 132 | </para>
|
---|
[f1a8ab0] | 133 |
|
---|
[bf6bb90] | 134 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
[f858bd7] | 135 | cd build &&
|
---|
| 136 |
|
---|
[91318eb] | 137 | meson setup .. \
|
---|
| 138 | --prefix=/usr \
|
---|
[20f070d8] | 139 | --buildtype=release \
|
---|
[2f59d11] | 140 | -Ddaemon_user=colord \
|
---|
| 141 | -Dvapi=true \
|
---|
| 142 | -Dsystemd=false \
|
---|
| 143 | -Dlibcolordcompat=true \
|
---|
| 144 | -Dargyllcms_sensor=false \
|
---|
| 145 | -Dbash_completion=false \
|
---|
| 146 | -Ddocs=false \
|
---|
[91318eb] | 147 | -Dman=false &&
|
---|
[bf6bb90] | 148 | ninja</userinput></screen>
|
---|
| 149 |
|
---|
| 150 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
[c89c282] | 151 | cd build &&
|
---|
[2f59d11] | 152 |
|
---|
[91318eb] | 153 | meson setup .. \
|
---|
| 154 | --prefix=/usr \
|
---|
[20f070d8] | 155 | --buildtype=release \
|
---|
[2f59d11] | 156 | -Ddaemon_user=colord \
|
---|
| 157 | -Dvapi=true \
|
---|
| 158 | -Dsystemd=true \
|
---|
| 159 | -Dlibcolordcompat=true \
|
---|
| 160 | -Dargyllcms_sensor=false \
|
---|
| 161 | -Dbash_completion=false \
|
---|
| 162 | -Ddocs=false \
|
---|
[91318eb] | 163 | -Dman=false &&
|
---|
[bf6bb90] | 164 | ninja</userinput></screen>
|
---|
[95381469] | 165 |
|
---|
[7ded7e3] | 166 | <para>
|
---|
| 167 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 168 | </para>
|
---|
[f1a8ab0] | 169 |
|
---|
[bf6bb90] | 170 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[f1a8ab0] | 171 |
|
---|
[d6da5da] | 172 | <para>
|
---|
[bc09992] | 173 | To test the results, issue: <command>ninja test</command>.
|
---|
| 174 | One test, <filename>colord-self-test-daemon</filename>, will fail if the
|
---|
| 175 | package is already installed. The test suite must be run with the
|
---|
| 176 | system-wide D-Bus Daemon running.
|
---|
[d6da5da] | 177 | </para>
|
---|
| 178 |
|
---|
[f1a8ab0] | 179 | </sect2>
|
---|
| 180 |
|
---|
| 181 | <sect2 role="commands">
|
---|
| 182 | <title>Command Explanations</title>
|
---|
| 183 |
|
---|
[20f070d8] | 184 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 185 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 186 |
|
---|
[28b61748] | 187 | <para>
|
---|
[2f59d11] | 188 | <parameter>-Ddaemon_user=colord</parameter>: This switch is used
|
---|
[1accff3c] | 189 | so the colord daemon will run as an unprivileged user instead of the
|
---|
[d6da5da] | 190 | <systemitem class="username">root</systemitem> user.
|
---|
[28b61748] | 191 | </para>
|
---|
| 192 |
|
---|
| 193 | <para>
|
---|
[2f59d11] | 194 | <parameter>-Dvapi=true</parameter>: This switch enables building
|
---|
[bf6bb90] | 195 | the <application>Vala</application> bindings. Remove if you don't have
|
---|
[1accff3c] | 196 | <xref linkend="vala"/> installed.
|
---|
[28b61748] | 197 | </para>
|
---|
| 198 |
|
---|
[bf6bb90] | 199 | <para revision="sysv">
|
---|
[2f59d11] | 200 | <parameter>-Dsystemd=false</parameter>: This switch disables
|
---|
[bf6bb90] | 201 | support for <application>systemd</application> login in Colord
|
---|
[8558044] | 202 | applications.
|
---|
[b194f2b] | 203 | </para>
|
---|
| 204 |
|
---|
[bf6bb90] | 205 | <para revision="systemd">
|
---|
[2f59d11] | 206 | <parameter>-Dsystemd=true</parameter>: This switch enables
|
---|
[bf6bb90] | 207 | installation of the <application>systemd</application> service.
|
---|
[82b5e658] | 208 | </para>
|
---|
| 209 |
|
---|
[03b4b3a] | 210 | <para>
|
---|
[2f59d11] | 211 | <parameter>-Dlibcolordcompat=true</parameter>: This switch enables
|
---|
[1accff3c] | 212 | building a compatibility library for older packages that use
|
---|
| 213 | <application>Colord</application>.
|
---|
[03b4b3a] | 214 | </para>
|
---|
[c647e6d] | 215 |
|
---|
[1accff3c] | 216 | <para>
|
---|
[2f59d11] | 217 | <parameter>-Dargyllcms_sensor=false</parameter>: This switch
|
---|
[bf6bb90] | 218 | disables the ArgLLCMS sensor driver. Omit if you have
|
---|
[6e2eb5cf] | 219 | <ulink url="https://www.argyllcms.com/">ArgyllCMS</ulink> installed
|
---|
[1accff3c] | 220 | and wish to use it.
|
---|
[2b872a2] | 221 | </para>
|
---|
| 222 |
|
---|
[2249a59] | 223 | <para>
|
---|
[2f59d11] | 224 | <parameter>-Dbash_completion=false</parameter>: This switch
|
---|
[bf6bb90] | 225 | disables Bash Completion support for Colord applications.
|
---|
[fa99d008] | 226 | </para>
|
---|
| 227 |
|
---|
| 228 | <para>
|
---|
[2f59d11] | 229 | <parameter>-Ddocs=false</parameter>: This switch disables building
|
---|
[c250033] | 230 | of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
|
---|
[fa99d008] | 231 | </para>
|
---|
| 232 |
|
---|
| 233 | <para>
|
---|
[2f59d11] | 234 | <parameter>-Dman=false</parameter>: This switch disables building
|
---|
[bf6bb90] | 235 | of man pages. Omit if you have <xref linkend="docbook-utils"/>
|
---|
[c250033] | 236 | available. Namespaced versions of the docbook-xsl stylesheets
|
---|
[4855935] | 237 | are also required.
|
---|
[fa99d008] | 238 | </para>
|
---|
| 239 |
|
---|
[f1a8ab0] | 240 | </sect2>
|
---|
| 241 |
|
---|
| 242 | <sect2 role="content">
|
---|
| 243 | <title>Contents</title>
|
---|
| 244 |
|
---|
| 245 | <segmentedlist>
|
---|
| 246 | <segtitle>Installed Programs</segtitle>
|
---|
[d6da5da] | 247 | <segtitle>Installed Libraries</segtitle>
|
---|
[f1a8ab0] | 248 | <segtitle>Installed Directories</segtitle>
|
---|
| 249 |
|
---|
| 250 | <seglistitem>
|
---|
[c341539] | 251 | <seg>
|
---|
[1accff3c] | 252 | cd-create-profile,
|
---|
| 253 | cd-fix-profile,
|
---|
| 254 | cd-iccdump,
|
---|
| 255 | cd-it8, and
|
---|
| 256 | colormgr
|
---|
[c341539] | 257 | </seg>
|
---|
| 258 | <seg>
|
---|
[1accff3c] | 259 | libcolord.so,
|
---|
| 260 | libcolordcompat.so,
|
---|
| 261 | libcolordprivate.so, and
|
---|
| 262 | libcolorhug.so
|
---|
[c341539] | 263 | </seg>
|
---|
| 264 | <seg>
|
---|
[7ded7e3] | 265 | /usr/include/colord-1,
|
---|
[7d7588a3] | 266 | /usr/lib/colord-{plugins,sensors},
|
---|
[1accff3c] | 267 | /usr/share/color{d},
|
---|
[7d7588a3] | 268 | /usr/share/gtk-doc/html/colord, and
|
---|
[c341539] | 269 | /var/lib/colord
|
---|
| 270 | </seg>
|
---|
[f1a8ab0] | 271 | </seglistitem>
|
---|
| 272 | </segmentedlist>
|
---|
| 273 |
|
---|
| 274 | <variablelist>
|
---|
| 275 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 276 | <?dbfo list-presentation="list"?>
|
---|
| 277 | <?dbhtml list-presentation="table"?>
|
---|
| 278 |
|
---|
[1accff3c] | 279 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 280 | package name, add -prog or -lib to the varlistentry entity id
|
---|
| 281 | and the 2nd entry of the indexterm zone entity -->
|
---|
| 282 |
|
---|
[f1a8ab0] | 283 | <varlistentry id="cd-create-profile">
|
---|
| 284 | <term><command>cd-create-profile</command></term>
|
---|
| 285 | <listitem>
|
---|
[7ded7e3] | 286 | <para>
|
---|
[4c24eb0a] | 287 | is the Color Manager Profile Creation Tool
|
---|
[7ded7e3] | 288 | </para>
|
---|
[f1a8ab0] | 289 | <indexterm zone="colord cd-create-profile">
|
---|
| 290 | <primary sortas="b-cd-create-profile">cd-create-profile</primary>
|
---|
| 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
| 294 |
|
---|
| 295 | <varlistentry id="cd-fix-profile">
|
---|
| 296 | <term><command>cd-fix-profile</command></term>
|
---|
| 297 | <listitem>
|
---|
[7ded7e3] | 298 | <para>
|
---|
[4c24eb0a] | 299 | is a tool used to fix metadata in ICC profiles
|
---|
[7ded7e3] | 300 | </para>
|
---|
[f1a8ab0] | 301 | <indexterm zone="colord cd-fix-profile">
|
---|
| 302 | <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
|
---|
| 303 | </indexterm>
|
---|
| 304 | </listitem>
|
---|
| 305 | </varlistentry>
|
---|
| 306 |
|
---|
[7d7588a3] | 307 | <varlistentry id="cd-iccdump">
|
---|
| 308 | <term><command>cd-iccdump</command></term>
|
---|
| 309 | <listitem>
|
---|
| 310 | <para>
|
---|
[4c24eb0a] | 311 | dumps the contents of an ICC profile as human readable text
|
---|
[7d7588a3] | 312 | </para>
|
---|
| 313 | <indexterm zone="colord cd-iccdump">
|
---|
| 314 | <primary sortas="b-cd-iccdump">cd-iccdump</primary>
|
---|
| 315 | </indexterm>
|
---|
| 316 | </listitem>
|
---|
| 317 | </varlistentry>
|
---|
| 318 |
|
---|
[06a322f] | 319 | <varlistentry id="cd-it8">
|
---|
| 320 | <term><command>cd-it8</command></term>
|
---|
| 321 | <listitem>
|
---|
| 322 | <para>
|
---|
[4c24eb0a] | 323 | is the Color Manager Testing Tool
|
---|
[06a322f] | 324 | </para>
|
---|
| 325 | <indexterm zone="colord cd-it8">
|
---|
| 326 | <primary sortas="b-cd-it8">cd-it8</primary>
|
---|
| 327 | </indexterm>
|
---|
| 328 | </listitem>
|
---|
| 329 | </varlistentry>
|
---|
| 330 |
|
---|
[f1a8ab0] | 331 | <varlistentry id="colormgr">
|
---|
| 332 | <term><command>colormgr</command></term>
|
---|
| 333 | <listitem>
|
---|
[7ded7e3] | 334 | <para>
|
---|
[1accff3c] | 335 | is a text-mode program that allows you to interact with colord on
|
---|
[4c24eb0a] | 336 | the command line
|
---|
[7ded7e3] | 337 | </para>
|
---|
[f1a8ab0] | 338 | <indexterm zone="colord colormgr">
|
---|
| 339 | <primary sortas="b-colormgr">colormgr</primary>
|
---|
| 340 | </indexterm>
|
---|
| 341 | </listitem>
|
---|
| 342 | </varlistentry>
|
---|
| 343 |
|
---|
[1accff3c] | 344 | <varlistentry id="libcolord.so">
|
---|
[c8f8332] | 345 | <term><filename class="libraryfile">libcolord.so</filename></term>
|
---|
[f1a8ab0] | 346 | <listitem>
|
---|
[7ded7e3] | 347 | <para>
|
---|
[4c24eb0a] | 348 | contains the <application>Colord</application> API functions
|
---|
[7ded7e3] | 349 | </para>
|
---|
[1accff3c] | 350 | <indexterm zone="colord libcolord.so">
|
---|
| 351 | <primary sortas="c-libcolord.so">libcolord.so</primary>
|
---|
[f1a8ab0] | 352 | </indexterm>
|
---|
| 353 | </listitem>
|
---|
| 354 | </varlistentry>
|
---|
| 355 |
|
---|
[1accff3c] | 356 | <varlistentry id="libcolordcompat.so">
|
---|
| 357 | <term><filename class="libraryfile">libcolordcompat.so</filename></term>
|
---|
| 358 | <listitem>
|
---|
| 359 | <para>
|
---|
| 360 | contains legacy API functions for compatibility with older
|
---|
[4c24eb0a] | 361 | applications
|
---|
[1accff3c] | 362 | </para>
|
---|
| 363 | <indexterm zone="colord libcolordcompat.so">
|
---|
| 364 | <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
|
---|
| 365 | </indexterm>
|
---|
| 366 | </listitem>
|
---|
| 367 | </varlistentry>
|
---|
[f1a8ab0] | 368 |
|
---|
[1accff3c] | 369 | <varlistentry id="libcolordprivate.so">
|
---|
| 370 | <term><filename class="libraryfile">libcolordprivate.so</filename></term>
|
---|
| 371 | <listitem>
|
---|
| 372 | <para>
|
---|
| 373 | contains internal API functions for the programs included with
|
---|
[4c24eb0a] | 374 | <application>Colord</application>
|
---|
[1accff3c] | 375 | </para>
|
---|
| 376 | <indexterm zone="colord libcolordprivate.so">
|
---|
| 377 | <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
|
---|
| 378 | </indexterm>
|
---|
| 379 | </listitem>
|
---|
| 380 | </varlistentry>
|
---|
[f1a8ab0] | 381 |
|
---|
[1accff3c] | 382 | <varlistentry id="libcolorhug.so">
|
---|
| 383 | <term><filename class="libraryfile">libcolorhug.so</filename></term>
|
---|
| 384 | <listitem>
|
---|
| 385 | <para>
|
---|
[4c24eb0a] | 386 | contains a simple display hardware colorimiter
|
---|
[1accff3c] | 387 | </para>
|
---|
| 388 | <indexterm zone="colord libcolorhug.so">
|
---|
| 389 | <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
|
---|
| 390 | </indexterm>
|
---|
| 391 | </listitem>
|
---|
| 392 | </varlistentry>
|
---|
| 393 | </variablelist>
|
---|
| 394 | </sect2>
|
---|
[4c24eb0a] | 395 |
|
---|
[f1a8ab0] | 396 | </sect1>
|
---|