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