[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 " ">
|
---|
[6b64a918] | 9 | <!ENTITY colord-md5sum "adc4501b54fb8667ee99f64cff87e12d">
|
---|
[bf6bb90] | 10 | <!ENTITY colord-size "1.8 MB">
|
---|
[6b64a918] | 11 | <!ENTITY colord-buildsize "31 MB (with tests)">
|
---|
| 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 |
|
---|
[34a6571] | 38 | &lfs110a_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 |
|
---|
[b1532549] | 126 | <para>
|
---|
| 127 | First, clean up about 100 warnings:
|
---|
| 128 | </para>
|
---|
[2f59d11] | 129 |
|
---|
| 130 | <screen><userinput>mv po/fur.po po/ur.po &&
|
---|
| 131 | sed -i 's/fur/ur/' po/LINGUAS</userinput></screen>
|
---|
| 132 |
|
---|
[7ded7e3] | 133 | <para>
|
---|
| 134 | Install <application>Colord</application> by running the following
|
---|
| 135 | commands:
|
---|
| 136 | </para>
|
---|
[f1a8ab0] | 137 |
|
---|
[bf6bb90] | 138 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
[f858bd7] | 139 | cd build &&
|
---|
| 140 |
|
---|
[2f59d11] | 141 | meson --prefix=/usr \
|
---|
[20f070d8] | 142 | --buildtype=release \
|
---|
[2f59d11] | 143 | -Ddaemon_user=colord \
|
---|
| 144 | -Dvapi=true \
|
---|
| 145 | -Dsystemd=false \
|
---|
| 146 | -Dlibcolordcompat=true \
|
---|
| 147 | -Dargyllcms_sensor=false \
|
---|
| 148 | -Dbash_completion=false \
|
---|
| 149 | -Ddocs=false \
|
---|
| 150 | -Dman=false .. &&
|
---|
[bf6bb90] | 151 | ninja</userinput></screen>
|
---|
| 152 |
|
---|
| 153 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
| 154 | cd build &&
|
---|
[2f59d11] | 155 |
|
---|
| 156 | meson --prefix=/usr \
|
---|
[20f070d8] | 157 | --buildtype=release \
|
---|
[2f59d11] | 158 | -Ddaemon_user=colord \
|
---|
| 159 | -Dvapi=true \
|
---|
| 160 | -Dsystemd=true \
|
---|
| 161 | -Dlibcolordcompat=true \
|
---|
| 162 | -Dargyllcms_sensor=false \
|
---|
| 163 | -Dbash_completion=false \
|
---|
| 164 | -Ddocs=false \
|
---|
| 165 | -Dman=false .. &&
|
---|
[bf6bb90] | 166 | ninja</userinput></screen>
|
---|
[95381469] | 167 |
|
---|
[7ded7e3] | 168 | <para>
|
---|
| 169 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 170 | </para>
|
---|
[f1a8ab0] | 171 |
|
---|
[bf6bb90] | 172 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[f1a8ab0] | 173 |
|
---|
[d6da5da] | 174 | <para>
|
---|
[bf6bb90] | 175 | To test the results, issue: <command>ninja -k 2 test</command>.
|
---|
| 176 | One test, <filename>colord-self-test-daemon</filename>, will fail.
|
---|
[1accff3c] | 177 | The test suite must be run after the package is installed, and the
|
---|
| 178 | system-wide D-Bus Daemon must be running.
|
---|
[d6da5da] | 179 | </para>
|
---|
| 180 |
|
---|
[f1a8ab0] | 181 | </sect2>
|
---|
| 182 |
|
---|
| 183 | <sect2 role="commands">
|
---|
| 184 | <title>Command Explanations</title>
|
---|
| 185 |
|
---|
[20f070d8] | 186 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 187 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 188 |
|
---|
[28b61748] | 189 | <para>
|
---|
[2f59d11] | 190 | <parameter>-Ddaemon_user=colord</parameter>: This switch is used
|
---|
[1accff3c] | 191 | so the colord daemon will run as an unprivileged user instead of the
|
---|
[d6da5da] | 192 | <systemitem class="username">root</systemitem> user.
|
---|
[28b61748] | 193 | </para>
|
---|
| 194 |
|
---|
| 195 | <para>
|
---|
[2f59d11] | 196 | <parameter>-Dvapi=true</parameter>: This switch enables building
|
---|
[bf6bb90] | 197 | the <application>Vala</application> bindings. Remove if you don't have
|
---|
[1accff3c] | 198 | <xref linkend="vala"/> installed.
|
---|
[28b61748] | 199 | </para>
|
---|
| 200 |
|
---|
[bf6bb90] | 201 | <para revision="sysv">
|
---|
[2f59d11] | 202 | <parameter>-Dsystemd=false</parameter>: This switch disables
|
---|
[bf6bb90] | 203 | support for <application>systemd</application> login in Colord
|
---|
[8558044] | 204 | applications.
|
---|
[b194f2b] | 205 | </para>
|
---|
| 206 |
|
---|
[bf6bb90] | 207 | <para revision="systemd">
|
---|
[2f59d11] | 208 | <parameter>-Dsystemd=true</parameter>: This switch enables
|
---|
[bf6bb90] | 209 | installation of the <application>systemd</application> service.
|
---|
[82b5e658] | 210 | </para>
|
---|
| 211 |
|
---|
[03b4b3a] | 212 | <para>
|
---|
[2f59d11] | 213 | <parameter>-Dlibcolordcompat=true</parameter>: This switch enables
|
---|
[1accff3c] | 214 | building a compatibility library for older packages that use
|
---|
| 215 | <application>Colord</application>.
|
---|
[03b4b3a] | 216 | </para>
|
---|
[c647e6d] | 217 |
|
---|
[1accff3c] | 218 | <para>
|
---|
[2f59d11] | 219 | <parameter>-Dargyllcms_sensor=false</parameter>: This switch
|
---|
[bf6bb90] | 220 | disables the ArgLLCMS sensor driver. Omit if you have
|
---|
[6b7881d] | 221 | <ulink url="http://www.argyllcms.com/">ArgyllCMS</ulink> installed
|
---|
[1accff3c] | 222 | and wish to use it.
|
---|
[2b872a2] | 223 | </para>
|
---|
| 224 |
|
---|
[2249a59] | 225 | <para>
|
---|
[2f59d11] | 226 | <parameter>-Dbash_completion=false</parameter>: This switch
|
---|
[bf6bb90] | 227 | disables Bash Completion support for Colord applications.
|
---|
[fa99d008] | 228 | </para>
|
---|
| 229 |
|
---|
| 230 | <para>
|
---|
[2f59d11] | 231 | <parameter>-Ddocs=false</parameter>: This switch disables building
|
---|
[c250033] | 232 | of documentation. Omit if you have <xref linkend="gtk-doc"/> available.
|
---|
[fa99d008] | 233 | </para>
|
---|
| 234 |
|
---|
| 235 | <para>
|
---|
[2f59d11] | 236 | <parameter>-Dman=false</parameter>: This switch disables building
|
---|
[bf6bb90] | 237 | of man pages. Omit if you have <xref linkend="docbook-utils"/>
|
---|
[c250033] | 238 | available. Namespaced versions of the docbook-xsl stylesheets
|
---|
[4855935] | 239 | are also required.
|
---|
[fa99d008] | 240 | </para>
|
---|
| 241 |
|
---|
[f1a8ab0] | 242 | </sect2>
|
---|
| 243 |
|
---|
| 244 | <sect2 role="content">
|
---|
| 245 | <title>Contents</title>
|
---|
| 246 |
|
---|
| 247 | <segmentedlist>
|
---|
| 248 | <segtitle>Installed Programs</segtitle>
|
---|
[d6da5da] | 249 | <segtitle>Installed Libraries</segtitle>
|
---|
[f1a8ab0] | 250 | <segtitle>Installed Directories</segtitle>
|
---|
| 251 |
|
---|
| 252 | <seglistitem>
|
---|
[c341539] | 253 | <seg>
|
---|
[1accff3c] | 254 | cd-create-profile,
|
---|
| 255 | cd-fix-profile,
|
---|
| 256 | cd-iccdump,
|
---|
| 257 | cd-it8, and
|
---|
| 258 | colormgr
|
---|
[c341539] | 259 | </seg>
|
---|
| 260 | <seg>
|
---|
[1accff3c] | 261 | libcolord.so,
|
---|
| 262 | libcolordcompat.so,
|
---|
| 263 | libcolordprivate.so, and
|
---|
| 264 | libcolorhug.so
|
---|
[c341539] | 265 | </seg>
|
---|
| 266 | <seg>
|
---|
[7ded7e3] | 267 | /usr/include/colord-1,
|
---|
[7d7588a3] | 268 | /usr/lib/colord-{plugins,sensors},
|
---|
[1accff3c] | 269 | /usr/share/color{d},
|
---|
[7d7588a3] | 270 | /usr/share/gtk-doc/html/colord, and
|
---|
[c341539] | 271 | /var/lib/colord
|
---|
| 272 | </seg>
|
---|
[f1a8ab0] | 273 | </seglistitem>
|
---|
| 274 | </segmentedlist>
|
---|
| 275 |
|
---|
| 276 | <variablelist>
|
---|
| 277 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 278 | <?dbfo list-presentation="list"?>
|
---|
| 279 | <?dbhtml list-presentation="table"?>
|
---|
| 280 |
|
---|
[1accff3c] | 281 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 282 | package name, add -prog or -lib to the varlistentry entity id
|
---|
| 283 | and the 2nd entry of the indexterm zone entity -->
|
---|
| 284 |
|
---|
[f1a8ab0] | 285 | <varlistentry id="cd-create-profile">
|
---|
| 286 | <term><command>cd-create-profile</command></term>
|
---|
| 287 | <listitem>
|
---|
[7ded7e3] | 288 | <para>
|
---|
[4c24eb0a] | 289 | is the Color Manager Profile Creation Tool
|
---|
[7ded7e3] | 290 | </para>
|
---|
[f1a8ab0] | 291 | <indexterm zone="colord cd-create-profile">
|
---|
| 292 | <primary sortas="b-cd-create-profile">cd-create-profile</primary>
|
---|
| 293 | </indexterm>
|
---|
| 294 | </listitem>
|
---|
| 295 | </varlistentry>
|
---|
| 296 |
|
---|
| 297 | <varlistentry id="cd-fix-profile">
|
---|
| 298 | <term><command>cd-fix-profile</command></term>
|
---|
| 299 | <listitem>
|
---|
[7ded7e3] | 300 | <para>
|
---|
[4c24eb0a] | 301 | is a tool used to fix metadata in ICC profiles
|
---|
[7ded7e3] | 302 | </para>
|
---|
[f1a8ab0] | 303 | <indexterm zone="colord cd-fix-profile">
|
---|
| 304 | <primary sortas="b-cd-fix-profile">cd-fix-profile</primary>
|
---|
| 305 | </indexterm>
|
---|
| 306 | </listitem>
|
---|
| 307 | </varlistentry>
|
---|
| 308 |
|
---|
[7d7588a3] | 309 | <varlistentry id="cd-iccdump">
|
---|
| 310 | <term><command>cd-iccdump</command></term>
|
---|
| 311 | <listitem>
|
---|
| 312 | <para>
|
---|
[4c24eb0a] | 313 | dumps the contents of an ICC profile as human readable text
|
---|
[7d7588a3] | 314 | </para>
|
---|
| 315 | <indexterm zone="colord cd-iccdump">
|
---|
| 316 | <primary sortas="b-cd-iccdump">cd-iccdump</primary>
|
---|
| 317 | </indexterm>
|
---|
| 318 | </listitem>
|
---|
| 319 | </varlistentry>
|
---|
| 320 |
|
---|
[06a322f] | 321 | <varlistentry id="cd-it8">
|
---|
| 322 | <term><command>cd-it8</command></term>
|
---|
| 323 | <listitem>
|
---|
| 324 | <para>
|
---|
[4c24eb0a] | 325 | is the Color Manager Testing Tool
|
---|
[06a322f] | 326 | </para>
|
---|
| 327 | <indexterm zone="colord cd-it8">
|
---|
| 328 | <primary sortas="b-cd-it8">cd-it8</primary>
|
---|
| 329 | </indexterm>
|
---|
| 330 | </listitem>
|
---|
| 331 | </varlistentry>
|
---|
| 332 |
|
---|
[f1a8ab0] | 333 | <varlistentry id="colormgr">
|
---|
| 334 | <term><command>colormgr</command></term>
|
---|
| 335 | <listitem>
|
---|
[7ded7e3] | 336 | <para>
|
---|
[1accff3c] | 337 | is a text-mode program that allows you to interact with colord on
|
---|
[4c24eb0a] | 338 | the command line
|
---|
[7ded7e3] | 339 | </para>
|
---|
[f1a8ab0] | 340 | <indexterm zone="colord colormgr">
|
---|
| 341 | <primary sortas="b-colormgr">colormgr</primary>
|
---|
| 342 | </indexterm>
|
---|
| 343 | </listitem>
|
---|
| 344 | </varlistentry>
|
---|
| 345 |
|
---|
[1accff3c] | 346 | <varlistentry id="libcolord.so">
|
---|
[c8f8332] | 347 | <term><filename class="libraryfile">libcolord.so</filename></term>
|
---|
[f1a8ab0] | 348 | <listitem>
|
---|
[7ded7e3] | 349 | <para>
|
---|
[4c24eb0a] | 350 | contains the <application>Colord</application> API functions
|
---|
[7ded7e3] | 351 | </para>
|
---|
[1accff3c] | 352 | <indexterm zone="colord libcolord.so">
|
---|
| 353 | <primary sortas="c-libcolord.so">libcolord.so</primary>
|
---|
[f1a8ab0] | 354 | </indexterm>
|
---|
| 355 | </listitem>
|
---|
| 356 | </varlistentry>
|
---|
| 357 |
|
---|
[1accff3c] | 358 | <varlistentry id="libcolordcompat.so">
|
---|
| 359 | <term><filename class="libraryfile">libcolordcompat.so</filename></term>
|
---|
| 360 | <listitem>
|
---|
| 361 | <para>
|
---|
| 362 | contains legacy API functions for compatibility with older
|
---|
[4c24eb0a] | 363 | applications
|
---|
[1accff3c] | 364 | </para>
|
---|
| 365 | <indexterm zone="colord libcolordcompat.so">
|
---|
| 366 | <primary sortas="c-libcolordcompat.so">libcolordcompat.so</primary>
|
---|
| 367 | </indexterm>
|
---|
| 368 | </listitem>
|
---|
| 369 | </varlistentry>
|
---|
[f1a8ab0] | 370 |
|
---|
[1accff3c] | 371 | <varlistentry id="libcolordprivate.so">
|
---|
| 372 | <term><filename class="libraryfile">libcolordprivate.so</filename></term>
|
---|
| 373 | <listitem>
|
---|
| 374 | <para>
|
---|
| 375 | contains internal API functions for the programs included with
|
---|
[4c24eb0a] | 376 | <application>Colord</application>
|
---|
[1accff3c] | 377 | </para>
|
---|
| 378 | <indexterm zone="colord libcolordprivate.so">
|
---|
| 379 | <primary sortas="c-libcolordprivate.so">libcolordprivate.so</primary>
|
---|
| 380 | </indexterm>
|
---|
| 381 | </listitem>
|
---|
| 382 | </varlistentry>
|
---|
[f1a8ab0] | 383 |
|
---|
[1accff3c] | 384 | <varlistentry id="libcolorhug.so">
|
---|
| 385 | <term><filename class="libraryfile">libcolorhug.so</filename></term>
|
---|
| 386 | <listitem>
|
---|
| 387 | <para>
|
---|
[4c24eb0a] | 388 | contains a simple display hardware colorimiter
|
---|
[1accff3c] | 389 | </para>
|
---|
| 390 | <indexterm zone="colord libcolorhug.so">
|
---|
| 391 | <primary sortas="c-libcolorhug.so">libcolorhug.so</primary>
|
---|
| 392 | </indexterm>
|
---|
| 393 | </listitem>
|
---|
| 394 | </varlistentry>
|
---|
| 395 | </variablelist>
|
---|
| 396 | </sect2>
|
---|
[4c24eb0a] | 397 |
|
---|
[f1a8ab0] | 398 | </sect1>
|
---|