source: pst/printing/cups-filters.xml@ 53e1509

11.0 qt5new trunk
Last change on this file since 53e1509 was 53e1509, checked in by Douglas R. Reno <renodr@…>, 4 months ago

cups-filters: Stop modifying the systemd unit for cups-browsed now that
we're using OpenPrinting CUPS.

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