[dcbd2c6] | 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 |
|
---|
[b26bc4c] | 7 | <!ENTITY cups-filters-download-http
|
---|
[4634c7a] | 8 | "https://www.openprinting.org/download/cups-filters/cups-filters-&cups-filters-version;.tar.xz">
|
---|
[dcbd2c6] | 9 | <!ENTITY cups-filters-download-ftp " ">
|
---|
[2cc15a2b] | 10 | <!ENTITY cups-filters-md5sum "24bed15110499fd652d65d6baab85ca6">
|
---|
[db6385b] | 11 | <!ENTITY cups-filters-size "1.4 MB">
|
---|
[2cc15a2b] | 12 | <!ENTITY cups-filters-buildsize "56 MB (with tests), 16 MB installed">
|
---|
[59eea9d] | 13 | <!ENTITY cups-filters-time "0.2 SBU (Using parallelism=4; with tests)">
|
---|
[dcbd2c6] | 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="cups-filters" xreflabel="cups-filters-&cups-filters-version;">
|
---|
| 17 | <?dbhtml filename="cups-filters.html"?>
|
---|
| 18 |
|
---|
| 19 |
|
---|
| 20 | <title>cups-filters-&cups-filters-version;</title>
|
---|
| 21 |
|
---|
| 22 | <indexterm zone="cups-filters">
|
---|
| 23 | <primary sortas="a-cups-filters">cups-filters</primary>
|
---|
| 24 | </indexterm>
|
---|
| 25 |
|
---|
| 26 | <sect2 role="package">
|
---|
| 27 | <title>Introduction to CUPS Filters</title>
|
---|
| 28 |
|
---|
| 29 | <para>
|
---|
| 30 | The <application>CUPS Filters</application> package contains backends,
|
---|
| 31 | filters and other software that was once part of the core
|
---|
| 32 | <application>CUPS</application> distribution but is no longer
|
---|
| 33 | maintained by Apple Inc.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
[dbd73d6] | 36 | &lfs113_checked;
|
---|
[dcbd2c6] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&cups-filters-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&cups-filters-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &cups-filters-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &cups-filters-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &cups-filters-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &cups-filters-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
[2f1053c] | 71 |
|
---|
[9fd586e9] | 72 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 73 | <itemizedlist spacing="compact">
|
---|
| 74 | <listitem>
|
---|
| 75 | <para>
|
---|
| 76 | Required patch:
|
---|
| 77 | <ulink url="&patch-root;/cups-filters-&cups-filters-version;-security_fix-1.patch"/>
|
---|
| 78 | </para>
|
---|
| 79 | </listitem>
|
---|
| 80 | </itemizedlist>
|
---|
| 81 |
|
---|
[dcbd2c6] | 82 | <bridgehead renderas="sect3">CUPS Filters Dependencies</bridgehead>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 85 | <para role="required">
|
---|
| 86 | <xref linkend="cups"/>,
|
---|
[f473955b] | 87 | <xref linkend="glib2"/>,
|
---|
[4118724f] | 88 | <xref linkend="gs"/>,
|
---|
[9d8cb37] | 89 | <xref linkend="lcms2"/>,
|
---|
[4118724f] | 90 | <xref linkend="poppler"/>, and
|
---|
[9d8cb37] | 91 | <xref linkend="qpdf"/>
|
---|
[dcbd2c6] | 92 | </para>
|
---|
| 93 |
|
---|
| 94 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 95 | <para role="recommended">
|
---|
[681cda1] | 96 | <xref linkend="dejavu-fonts"/> (the build fails if they are not
|
---|
| 97 | installed, although they are only required for the tests),
|
---|
[2cc15a2b] | 98 | <xref linkend="libexif"/>,
|
---|
[dcbd2c6] | 99 | <xref linkend="libjpeg"/>,
|
---|
[10cbf37] | 100 | <xref linkend="libpng"/>,
|
---|
[681cda1] | 101 | <xref linkend="libtiff"/>, and
|
---|
[2f727d8f] | 102 | <xref linkend="mupdf"/> (mutool)
|
---|
[dcbd2c6] | 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 106 | <para role="optional">
|
---|
[681cda1] | 107 | <xref linkend="avahi"/> (required to build the DNSSD backend of the
|
---|
| 108 | <command>cups-browsed</command> daemon, which is needed for operating
|
---|
| 109 | some network printers),
|
---|
[cad913e0] | 110 | <xref linkend="openldap"/>,
|
---|
[d42f02c6] | 111 | <xref linkend="php"/> (use of this might be broken),
|
---|
[75b1a338] | 112 | <ulink url="https://liblouis.github.io/downloads/">Liblouis (Braille)</ulink>, and
|
---|
| 113 | <ulink url="https://liblouis.github.io/downloads/">Liblouisutdml (Braille)</ulink>
|
---|
[dcbd2c6] | 114 | </para>
|
---|
| 115 |
|
---|
[4118724f] | 116 | <bridgehead renderas="sect4">Optional printer drivers (runtime)</bridgehead>
|
---|
| 117 | <para role="optional">
|
---|
[f5cdf41] | 118 | <xref role="runtime" linkend="gutenprint"/> (for supported printers),
|
---|
| 119 | or other printer drivers, such as <ulink role="runtime"
|
---|
[c6b192c] | 120 | url="https://sourceforge.net/projects/hplip/files/hplip/">hplip</ulink>
|
---|
[dcbd2c6] | 121 | </para>
|
---|
| 122 |
|
---|
| 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 | <sect2 role="installation">
|
---|
| 126 | <title>Installation of CUPS Filters</title>
|
---|
| 127 |
|
---|
[53e1509] | 128 | <!--
|
---|
[c480c33] | 129 | <para revision="systemd">
|
---|
| 130 | First, fix the systemd unit file to work with
|
---|
| 131 | <application>CUPS</application> 2.0 and later:
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
| 134 | <screen revision="systemd"><userinput>sed -i "s:cups.service:org.cups.cupsd.service:g" utils/cups-browsed.service</userinput></screen>
|
---|
[53e1509] | 135 | -->
|
---|
[c480c33] | 136 |
|
---|
[9fd586e9] | 137 | <para>
|
---|
| 138 | First, fix a security vulnerability that can allow for remote code
|
---|
| 139 | execution with the 'beh' printer backend:
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
| 142 | <screen><userinput remap="pre">patch -Np1 -i ../cups-filters-&cups-filters-version;-security_fix-1.patch</userinput></screen>
|
---|
| 143 |
|
---|
[dcbd2c6] | 144 | <para>
|
---|
| 145 | Install <application>CUPS Filters</application> by running the following
|
---|
| 146 | commands:
|
---|
| 147 | </para>
|
---|
[7b88d5a] | 148 |
|
---|
[21e0c46] | 149 | <screen><userinput>CXXFLAGS="$CXXFLAGS -std=c++17" \
|
---|
| 150 | ./configure --prefix=/usr \
|
---|
[83dc192] | 151 | --sysconfdir=/etc \
|
---|
| 152 | --localstatedir=/var \
|
---|
| 153 | --without-rcdir \
|
---|
| 154 | --disable-static \
|
---|
| 155 | --disable-avahi \
|
---|
| 156 | --docdir=/usr/share/doc/cups-filters-&cups-filters-version; &&
|
---|
[dcbd2c6] | 157 | make</userinput></screen>
|
---|
| 158 |
|
---|
[c480c33] | 159 | <!-- The test suite still bombs out for me. I'll leave the instructions for it
|
---|
| 160 | here though. I didn't have the Dejavu font installed, but used one of the
|
---|
[3bb415b] | 161 | ones installed by X.
|
---|
| 162 | Version 1.16.0: test worked for me with "make check >testlog 2>&1",
|
---|
[747fcf5] | 163 | that is, the other way around. I have DejaVu fonts. Pierre L
|
---|
[8558044] | 164 | With 1.17.2 (and DejaVu) the test output is clean, no need for a log. Ken
|
---|
| 165 |
|
---|
[db6385b] | 166 | Tests are clean for version 1.21.0 (and version 1.21.5): - Bruce
|
---|
[8558044] | 167 | # TOTAL: 6
|
---|
| 168 | # PASS: 6
|
---|
| 169 | real 0m2.504s -->
|
---|
[c480c33] | 170 |
|
---|
[dcbd2c6] | 171 | <para>
|
---|
[4118724f] | 172 | To test the results, issue:
|
---|
[6213b66] | 173 | <!--<command>make check >testlog 2>&1</command>.-->
|
---|
[747fcf5] | 174 | <command>make check</command>. DejaVu fonts
|
---|
[4118724f] | 175 | are needed for the tests.
|
---|
[dcbd2c6] | 176 | </para>
|
---|
| 177 |
|
---|
| 178 | <para>
|
---|
| 179 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
| 182 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 183 |
|
---|
[c480c33] | 184 | <para revision="systemd">
|
---|
| 185 | Install the systemd unit by running the following command as the
|
---|
| 186 | <systemitem class="username">root</systemitem> user:
|
---|
| 187 | </para>
|
---|
| 188 |
|
---|
| 189 | <screen role="root" revision="systemd"><userinput>install -v -m644 utils/cups-browsed.service /lib/systemd/system/cups-browsed.service</userinput></screen>
|
---|
| 190 |
|
---|
[dcbd2c6] | 191 | </sect2>
|
---|
| 192 |
|
---|
| 193 | <sect2 role="commands">
|
---|
| 194 | <title>Command Explanations</title>
|
---|
[cfc1f98] | 195 |
|
---|
[10cbf37] | 196 | <!-- please comment this if no patches are currently needed -->
|
---|
[1c459bf2] | 197 | <!--<para>
|
---|
[10cbf37] | 198 | <parameter>patch -Np1 -i ../cups-filters-&cups-filters-version;-poppler71-1.patch</parameter>:
|
---|
[2f1053c] | 199 | Conditionally apply changes for recent versions of poppler.
|
---|
[8558044] | 200 | </para>
|
---|
[1c459bf2] | 201 | Poppler-0.72.0, cups-filters-1.21.5 - no longer needed.-->
|
---|
[cfc1f98] | 202 |
|
---|
[21e0c46] | 203 | <para>
|
---|
| 204 | <envar>CXXFLAGS="$CXXFLAGS -std=c++17"</envar>: This environment
|
---|
[912b324] | 205 | variable is necessary to fix a problem introduced by qpdf-11.3.0.
|
---|
[21e0c46] | 206 | </para>
|
---|
| 207 |
|
---|
[03a0a638] | 208 | <para>
|
---|
| 209 | <parameter>--disable-avahi</parameter>: This switch is needed
|
---|
| 210 | if the optional <xref linkend="avahi"/> is not installed. Remove
|
---|
| 211 | it if avahi is installed and you need network printer discovery
|
---|
| 212 | capabilities.
|
---|
| 213 | </para>
|
---|
| 214 |
|
---|
[cbda2a25] | 215 | <para>
|
---|
[d6da5da] | 216 | <parameter>--without-rcdir</parameter>: This switch disables
|
---|
| 217 | installation of the bundled bootscript which is not compatible
|
---|
| 218 | with BLFS.
|
---|
[cbda2a25] | 219 | </para>
|
---|
| 220 |
|
---|
[4118724f] | 221 | <!-- Those are hard dependencies now
|
---|
[dcbd2c6] | 222 | <para>
|
---|
[4118724f] | 223 | <parameter>- -with-gs-path=/usr/bin/gs</parameter>: This switch
|
---|
[dcbd2c6] | 224 | defines the path to the <application>GhostScript</application>
|
---|
| 225 | binary in case <xref linkend="gs"/> is not installed at build time.
|
---|
| 226 | </para>
|
---|
| 227 |
|
---|
| 228 | <para>
|
---|
[4118724f] | 229 | <parameter>- -with-pdftops-path=/usr/bin/gs</parameter>: This switch
|
---|
[dcbd2c6] | 230 | defines the path to the <application>GhostScript</application>
|
---|
| 231 | binary in case <xref linkend="gs"/> is not installed at build time.
|
---|
| 232 | </para>
|
---|
[4118724f] | 233 | -->
|
---|
[dcbd2c6] | 234 |
|
---|
[bfa09457] | 235 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 236 | href="../../xincludes/static-libraries.xml"/>
|
---|
[39555dd] | 237 | <!--
|
---|
[2f1053c] | 238 | <para>
|
---|
[39555dd] | 239 | <option>- -enable-ijs</option>: This switch will allow the pdftoijs
|
---|
[2f1053c] | 240 | filter, for sending PDFs to an HP InkJet Server, to be built.
|
---|
| 241 | </para>
|
---|
[39555dd] | 242 | -->
|
---|
[2f1053c] | 243 |
|
---|
[8e1a075] | 244 | <para>
|
---|
[681cda1] | 245 | <option>--with-test-font-path=<replaceable>VALUE</replaceable></option>:
|
---|
| 246 | If you wish to run the tests, but
|
---|
[8e1a075] | 247 | you do not have the default
|
---|
[681cda1] | 248 | <filename>/usr/share/fonts/dejavu/DejaVuSans.ttf</filename> use this
|
---|
| 249 | switch to specify where <filename>DejaVuSans.ttf</filename> (or perhaps
|
---|
| 250 | some other text TTF font - untested) is located.
|
---|
[8e1a075] | 251 | </para>
|
---|
[681cda1] | 252 |
|
---|
[8e1a075] | 253 |
|
---|
[dcbd2c6] | 254 | </sect2>
|
---|
| 255 |
|
---|
[cbda2a25] | 256 | <!-- TODO: Write a bootscript for cups-browsed -->
|
---|
| 257 |
|
---|
[c480c33] | 258 | <sect2 role="configuration" revision="systemd">
|
---|
| 259 | <title>Configuring CUPS Filters</title>
|
---|
| 260 |
|
---|
| 261 | <sect3 id="cups-filters-init">
|
---|
| 262 | <title>Systemd Units</title>
|
---|
| 263 |
|
---|
| 264 | <para>
|
---|
| 265 | To start the <command>cups-browsed</command> daemon at boot, enable
|
---|
| 266 | the previously installed systemd unit by running the following command
|
---|
| 267 | as the <systemitem class="username">root</systemitem> user:
|
---|
| 268 | </para>
|
---|
| 269 |
|
---|
| 270 | <indexterm zone="cups-filters cups-filters-init">
|
---|
| 271 | <primary sortas="f-cups-browsed">cups-browsed</primary>
|
---|
| 272 | </indexterm>
|
---|
| 273 |
|
---|
| 274 | <screen role="root"><userinput>systemctl enable cups-browsed</userinput></screen>
|
---|
| 275 |
|
---|
| 276 | </sect3>
|
---|
[8558044] | 277 |
|
---|
[c480c33] | 278 | </sect2>
|
---|
| 279 |
|
---|
[dcbd2c6] | 280 | <sect2 role="content">
|
---|
| 281 | <title>Contents</title>
|
---|
| 282 |
|
---|
| 283 | <segmentedlist>
|
---|
[cbda2a25] | 284 | <segtitle>Installed Programs</segtitle>
|
---|
[dcbd2c6] | 285 | <segtitle>Installed Libraries</segtitle>
|
---|
| 286 | <segtitle>Installed Directories</segtitle>
|
---|
| 287 |
|
---|
| 288 | <seglistitem>
|
---|
| 289 | <seg>
|
---|
[98fd8b9] | 290 | cups-browsed, driverless, driverless-fax, and foomatic-rip
|
---|
| 291 | <!-- and ttfread -->
|
---|
[dcbd2c6] | 292 | </seg>
|
---|
| 293 | <seg>
|
---|
| 294 | libcupsfilters.so and libfontembed.so
|
---|
| 295 | </seg>
|
---|
| 296 | <seg>
|
---|
[7374e16] | 297 | /usr/include/{cupsfilters,fontembed},
|
---|
[fc0e436] | 298 | /usr/lib/cups/{backend,driver,filter},
|
---|
[d42f02c6] | 299 | /usr/share/cups/{braille,charsets},
|
---|
[a82b5f44] | 300 | /usr/share/doc/cups-filters-&cups-filters-version;, and
|
---|
[7273ffc] | 301 | /usr/share/ppd/cupsfilters
|
---|
[dcbd2c6] | 302 | </seg>
|
---|
| 303 | </seglistitem>
|
---|
| 304 | </segmentedlist>
|
---|
| 305 |
|
---|
| 306 | <variablelist>
|
---|
| 307 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 308 | <?dbfo list-presentation="list"?>
|
---|
| 309 | <?dbhtml list-presentation="table"?>
|
---|
| 310 |
|
---|
[298fee30] | 311 | <varlistentry id="cups-browsed">
|
---|
| 312 | <term><command>cups-browsed</command></term>
|
---|
[7374e16] | 313 | <listitem>
|
---|
| 314 | <para>
|
---|
[298fee30] | 315 | is a daemon for browsing the Bonjour and CUPS broadcasts of shared,
|
---|
[4c24eb0a] | 316 | remote CUPS printers
|
---|
[7374e16] | 317 | </para>
|
---|
[298fee30] | 318 | <indexterm zone="cups-filters cups-browsed">
|
---|
| 319 | <primary sortas="b-cups-browsed">cups-browsed</primary>
|
---|
[7374e16] | 320 | </indexterm>
|
---|
[a82b5f44] | 321 | </listitem>
|
---|
| 322 | </varlistentry>
|
---|
| 323 |
|
---|
| 324 | <varlistentry id="driverless">
|
---|
| 325 | <term><command>driverless</command></term>
|
---|
| 326 | <listitem>
|
---|
| 327 | <para>
|
---|
[4c24eb0a] | 328 | is a PPD generator utility for driverless printing
|
---|
[a82b5f44] | 329 | </para>
|
---|
| 330 | <indexterm zone="cups-filters driverless">
|
---|
| 331 | <primary sortas="b-driverless">driverless</primary>
|
---|
| 332 | </indexterm>
|
---|
| 333 | </listitem>
|
---|
| 334 | </varlistentry>
|
---|
| 335 |
|
---|
| 336 | <varlistentry id="driverless-fax">
|
---|
| 337 | <term><command>driverless-fax</command></term>
|
---|
| 338 | <listitem>
|
---|
| 339 | <para>
|
---|
[4c24eb0a] | 340 | is a wrapper to <command>driverless</command> for FAX type devices
|
---|
[a82b5f44] | 341 | </para>
|
---|
| 342 | <indexterm zone="cups-filters driverless-fax">
|
---|
| 343 | <primary sortas="b-driverless-fax">driverless-fax</primary>
|
---|
| 344 | </indexterm>
|
---|
[7374e16] | 345 | </listitem>
|
---|
| 346 | </varlistentry>
|
---|
| 347 |
|
---|
[298fee30] | 348 | <varlistentry id="foomatic-rip">
|
---|
| 349 | <term><command>foomatic-rip</command></term>
|
---|
[7374e16] | 350 | <listitem>
|
---|
| 351 | <para>
|
---|
[298fee30] | 352 | is a universal print filter/RIP wrapper which can be used as CUPS
|
---|
[4c24eb0a] | 353 | filter or stand-alone for spooler-less, direct printing
|
---|
[7374e16] | 354 | </para>
|
---|
[298fee30] | 355 | <indexterm zone="cups-filters foomatic-rip">
|
---|
| 356 | <primary sortas="b-foomatic-rip">foomatic-rip</primary>
|
---|
[7374e16] | 357 | </indexterm>
|
---|
| 358 | </listitem>
|
---|
| 359 | </varlistentry>
|
---|
| 360 |
|
---|
[dcbd2c6] | 361 | <varlistentry id="libcupsfilters">
|
---|
| 362 | <term><filename class="libraryfile">libcupsfilters.so</filename></term>
|
---|
| 363 | <listitem>
|
---|
| 364 | <para>
|
---|
[4c24eb0a] | 365 | contains <application>CUPS Filters</application> API functions
|
---|
[dcbd2c6] | 366 | </para>
|
---|
| 367 | <indexterm zone="cups-filters libcupsfilters">
|
---|
| 368 | <primary sortas="c-libcupsfilters">libcupsfilters.so</primary>
|
---|
| 369 | </indexterm>
|
---|
| 370 | </listitem>
|
---|
| 371 | </varlistentry>
|
---|
| 372 |
|
---|
| 373 | </variablelist>
|
---|
| 374 |
|
---|
| 375 | </sect2>
|
---|
| 376 |
|
---|
| 377 | </sect1>
|
---|