source: pst/printing/cups.xml@ a217f28

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since a217f28 was a217f28, checked in by DJ Lucas <dj@…>, 14 years ago

Added note to cups page about the new CUPS USB backend and usblp driver being incompatible.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@8616 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 17.4 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-download-http "http://ftp.easysw.com/pub/cups/&cups-version;/cups-&cups-version;-source.tar.bz2">
8 <!ENTITY cups-download-ftp "ftp://ftp.easysw.com/pub/cups/&cups-version;/cups-&cups-version;-source.tar.bz2">
9 <!ENTITY cups-md5sum "8776403ad60fea9e85eab9c04d88560d">
10 <!ENTITY cups-size "4.3 MB">
11 <!ENTITY cups-buildsize "79 MB">
12 <!ENTITY cups-time "0.7 SBU">
13]>
14
15<sect1 id="cups" xreflabel="CUPS-&cups-version;">
16 <?dbhtml filename="cups.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>CUPS-&cups-version;</title>
24
25 <indexterm zone="cups">
26 <primary sortas="a-CUPS">CUPS</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to CUPS</title>
31
32 <para>The Common Unix Printing System (CUPS) is a print spooler and
33 associated utilities. It is based on the "Internet Printing
34 Protocol" and provides printing services to most PostScript and raster
35 printers.</para>
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>Download (HTTP): <ulink url="&cups-download-http;"/></para>
41 </listitem>
42 <listitem>
43 <para>Download (FTP): <ulink url="&cups-download-ftp;"/></para>
44 </listitem>
45 <listitem>
46 <para>Download MD5 sum: &cups-md5sum;</para>
47 </listitem>
48 <listitem>
49 <para>Download size: &cups-size;</para>
50 </listitem>
51 <listitem>
52 <para>Estimated disk space required: &cups-buildsize;</para>
53 </listitem>
54 <listitem>
55 <para>Estimated build time: &cups-time;</para>
56 </listitem>
57 </itemizedlist>
58
59 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
60 <itemizedlist spacing="compact">
61 <listitem>
62 <para>Required patch: <ulink
63 url="&patch-root;/cups-&cups-version;-fix_broken_locking-1.patch"/></para>
64 </listitem>
65 </itemizedlist>
66
67 <bridgehead renderas="sect3">CUPS Dependencies</bridgehead>
68
69 <bridgehead renderas="sect4">Recommended</bridgehead>
70 <para role="recommended"><xref linkend="libjpeg"/>,
71 <xref linkend="libpng"/>, and
72 <xref linkend="libtiff"/></para>
73
74 <bridgehead renderas="sect4">Optional</bridgehead>
75 <para role="optional"><!-- <xref linkend="pkgconfig"/>, -->
76 <xref linkend="tcpwrappers"/>,
77 <xref linkend="dbus"/>,
78 <xref linkend="acl"/>,
79 <xref linkend="linux-pam"/>,
80 <xref linkend="openldap"/>,
81 <xref linkend="gnutls"/> or <xref linkend="openssl"/> (looked for in that order),
82 <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
83 <xref linkend="php"/>,
84 <xref linkend="python"/>,
85 <xref linkend="icedtea6"/> or <xref linkend="jdk"/>,
86 <ulink url="http://www.openslp.org/">OpenSLP</ulink>,
87 <ulink url="http://packages.debian.org/unstable/source/libpaper">libpaper</ulink>,
88 <ulink url="http://www.easysw.com/htmldoc/">HTMLDOC</ulink>, and
89 <ulink url="http://valgrind.org/">Valgrind</ulink> (optionally used if
90 running the test suites)</para>
91
92 <para condition="html" role="usernotes">User Notes:
93 <ulink url="&blfs-wiki;/cups"/></para>
94
95 </sect2>
96
97 <sect2 role="installation">
98 <title>Installation of CUPS</title>
99
100 <para>Create an <systemitem class="username">lp</systemitem> user, as
101 <application>CUPS</application> will create some files owned by this user.
102 (The <systemitem class="username">lp</systemitem> user is the default used
103 by <application>CUPS</application>, but may be changed to a different user
104 by passing a parameter to the <command>configure</command> script.) Use the
105 following command as the <systemitem class="username">root</systemitem>
106 user:</para>
107
108<screen role="root"><userinput>useradd -c "Print Service User" -d /dev/null -g lp -s /bin/false -u 9 lp</userinput></screen>
109
110 <note>
111 <para>If you plan to use a USB printer with
112 <application>CUPS</application>, do not enable the
113 <quote>usblp</quote> driver as either built-in or as a module in
114 your kernel configuration as it will cause the new
115 <application>CUPS</application> USB backend to fail.
116 <filename>/var/log/sys.log</filename> will contain entries similar to the
117 following:</para>
118
119 <screen>kernel: [54631.796465] usb 4-1: usbfs: interface 0 claimed by usblp while 'usb' sets config #1</screen>
120
121 <para>The kernel config option is
122 <parameter>CONFIG_USB_PRINTER</parameter>
123 and can be found in menuconfig under
124 <quote>Device Drivers ---> USB support --->
125 USB Printer support</quote>.</para>
126 </note>
127
128 <para>Install <application>CUPS</application> by running the
129 following commands:</para>
130
131<screen><userinput>patch -Np1 -i ../cups-&cups-version;-fix_broken_locking-1.patch &amp;&amp;
132./configure &amp;&amp;
133make</userinput></screen>
134
135 <para>To test the results, issue: <command>make check</command>. This will
136 run a basic test suite without any load testing. If you wish to run the
137 tests specifying non-default parameters, issue: <command>make test</command>.
138 Note that the <quote>torture load testing</quote> test uses more resources
139 than those displayed in the prompt.</para>
140
141 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
142
143<screen role="root"><userinput>make install</userinput></screen>
144
145 <para>The <application>man</application> files are installed in compressed
146 (<filename class='extension'>.gz</filename>) format. If desired, use the
147 following commands to uncompress them:</para>
148
149<screen role="root"><userinput>gunzip -v /usr/share/man/man{\
1501/{ppd{po,merge,html,c,i},cancel,cups{-config,test{dsc,ppd}},\
151lp{,options,passwd,q,rm,r,stat}}.1,\
1525/{{classes,client,cups-snmp,cupsd,printers,subscriptions,mailto}.conf,\
153mime.{convs,types},ppdcfile}.5,\
1547/{backend,filter,notifier,drv}.7,\
1558/{accept,cups{ctl,accept,filter,d,addsmb,enable,\
156-{deviced,driverd,lpd,polld}},lp{admin,info,move,c}}.8}.gz &amp;&amp;
157
158rm -v /usr/share/man/man8/{{,cups}reject,accept,cupsdisable}.8.gz &amp;&amp;
159ln -v -s cupsaccept.8 /usr/share/man/man8/reject.8 &amp;&amp;
160ln -v -s cupsaccept.8 /usr/share/man/man8/cupsreject.8 &amp;&amp;
161ln -v -s cupsaccept.8 /usr/share/man/man8/accept.8 &amp;&amp;
162ln -v -s cupsenable.8 /usr/share/man/man8/cupsdisable.8</userinput></screen>
163
164 </sect2>
165
166 <sect2 role="commands">
167 <title>Command Explanations</title>
168
169 <para>The basic default behavior of the installation is appropriate for
170 LFS systems. <application>CUPS</application> files are placed in
171 <filename class="directory">/usr/{bin,include,lib,sbin,share/cups}</filename>,
172 <filename class="directory">/var/{cache,log,run,spool}</filename>, and
173 <filename class="directory">/etc/{cups,pam.d,dbus-1/system.d</filename></para>
174
175 </sect2>
176
177 <sect2 role="configuration">
178 <title>Configuring CUPS</title>
179
180 <para>Configuration of <application>CUPS</application> is dependent on
181 the type of printer and can be complex. Generally, PostScript printers
182 are easier. For detailed instructions on configuration and use of
183 <application>CUPS</application>, see <ulink
184 url="http://www.cups.org/documentation.php"/>. The Software Administrators
185 Manual and Software Users Manual are particularly useful.</para>
186
187 <para>For non-PostScript printers to print with
188 <application>CUPS</application>, you need to install
189 <xref linkend="gs"/> to convert PostScript to raster images
190 and a driver (e.g., from <xref linkend="gutenprint"/>) to convert
191 the resulting raster images to a form that the printer understands.
192 <ulink url="http://www.linuxprinting.org/foomatic.html">Foomatic</ulink>
193 drivers use Ghostscript to convert PostScript to a printable form directly,
194 but this is considered to be a hack by
195 <application>CUPS</application> developers.</para>
196
197<!-- This should be obvious, not to mention the new problem with usblp.
198 Omitting completely for now.
199
200 <sect3 role="kernel" id="cups-kernel">
201 <title>Kernel Configuration</title>
202
203 <para>To use your printer you will likely need the appropriate drivers
204 enabled in the kernel &mdash; for example, <quote>Parallel printer
205 support</quote> if you have a parallel port printer, or <quote>USB Printer
206 support</quote> for a USB printer.</para>
207
208 </sect3>
209-->
210
211 <sect3 id="cups-init">
212 <title>Boot Script</title>
213
214 <para>During the installation, <application>CUPS</application> added
215 startup files in <filename class="directory">/etc/rc.d</filename>.
216 These scripts will work in most cases, but will fail if you provide
217 printers to <application>Samba</application> clients. Additionally,
218 they are not consistent with standard LFS style scripts. Replace the
219 installed scripts with the scripts and symlinks included in the
220 <xref linkend="bootscripts"/> package:</para>
221
222 <indexterm zone="cups cups-init">
223 <primary sortas="f-cups">cups</primary>
224 </indexterm>
225
226<screen role="root"><userinput>make install-cups</userinput></screen>
227
228 </sect3>
229
230 </sect2>
231
232 <sect2 role="content">
233 <title>Contents</title>
234
235 <segmentedlist>
236 <segtitle>Installed Programs</segtitle>
237 <segtitle>Installed Libraries</segtitle>
238 <segtitle>Installed Directories</segtitle>
239
240 <seglistitem>
241 <seg>accept, cancel, cups-config, cupsaccept, cupsaddsmb, cupsctl,
242 cupsd, cupsdisable, cupsenable, cupsfilter, cupsreject, cupstestdsc,
243 cupstestppd, lp, lpadmin, lpc, lpinfo, lpmove, lpoptions, lppasswd,
244 lpq, lpr, lprm, lpstat, ppdc, ppdhtml, ppdi, ppdmerge, ppdpo, reject</seg>
245 <seg>libcups.{so,a}, libcupscgi.{so,a}, libcupsdriver.{so,a},
246 libcupsimage.{so,a}, libcupsmime.{so,a}, libcupsppdc.{so,a}, and
247 various filters and backend drivers</seg>
248 <seg>/etc/cups, /usr/include/cups, /usr/lib/cups, /usr/share/cups,
249 /usr/share/doc/cups-&cups-version;, and
250 /var/{cache,log,run,spool}/cups</seg>
251 </seglistitem>
252 </segmentedlist>
253
254 <variablelist>
255 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
256 <?dbfo list-presentation="list"?>
257 <?dbhtml list-presentation="table"?>
258
259 <varlistentry id="accept">
260 <term><command>accept</command></term>
261 <listitem>
262 <para>instructs the printing system to accept print jobs to the
263 specified destinations.</para>
264 <indexterm zone="cups accept">
265 <primary sortas="b-accept">accept</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 <varlistentry id="cancel-cups">
271 <term><command>cancel</command></term>
272 <listitem>
273 <para>cancels existing print jobs from the print queues.</para>
274 <indexterm zone="cups cancel-cups">
275 <primary sortas="b-cancel">cancel</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="cups-config">
281 <term><command>cups-config</command></term>
282 <listitem>
283 <para>is a <application>CUPS</application>
284 program configuration utility.</para>
285 <indexterm zone="cups cups-config">
286 <primary sortas="b-cups-config">cups-config</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="cupsaddsmb">
292 <term><command>cupsaddsmb</command></term>
293 <listitem>
294 <para>exports printers to the <application>Samba</application>
295 software for use with Windows clients.</para>
296 <indexterm zone="cups cupsaddsmb">
297 <primary sortas="b-cupsaddsmb">cupsaddsmb</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="cupsd">
303 <term><command>cupsd</command></term>
304 <listitem>
305 <para>is the scheduler for the Common Unix Printing System.</para>
306 <indexterm zone="cups cupsd">
307 <primary sortas="b-cupsd">cupsd</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="cupstestppd">
313 <term><command>cupstestppd</command></term>
314 <listitem>
315 <para>tests the conformance of PPD files.</para>
316 <indexterm zone="cups cupstestppd">
317 <primary sortas="b-cupstestppd">cupstestppd</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="disable">
323 <term><command>disable</command></term>
324 <listitem>
325 <para>stops the named printers or classes.</para>
326 <indexterm zone="cups disable">
327 <primary sortas="b-disable">disable</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="enable">
333 <term><command>enable</command></term>
334 <listitem>
335 <para>starts the named printers or classes.</para>
336 <indexterm zone="cups enable">
337 <primary sortas="b-enable">enable</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="lp-cups">
343 <term><command>lp</command></term>
344 <listitem>
345 <para>submits files for printing or alters a pending job.</para>
346 <indexterm zone="cups lp-cups">
347 <primary sortas="b-lp">lp</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="lpadmin">
353 <term><command>lpadmin</command></term>
354 <listitem>
355 <para>configures printer and class queues provided by
356 <application>CUPS</application>.</para>
357 <indexterm zone="cups lpadmin">
358 <primary sortas="b-lpadmin">lpadmin</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="lpc-cups">
364 <term><command>lpc</command></term>
365 <listitem>
366 <para> provides limited control over printer and class queues
367 provided by <application>CUPS</application>.</para>
368 <indexterm zone="cups lpc-cups">
369 <primary sortas="b-lpc">lpc</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="lpinfo">
375 <term><command>lpinfo</command></term>
376 <listitem>
377 <para>lists the available devices or drivers known to the
378 <application>CUPS</application> server.</para>
379 <indexterm zone="cups lpinfo">
380 <primary sortas="b-lpinfo">lpinfo</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="lpmove">
386 <term><command>lpmove</command></term>
387 <listitem>
388 <para>moves the specified job to a new destination.</para>
389 <indexterm zone="cups lpmove">
390 <primary sortas="b-lpmove">lpmove</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="lpoptions">
396 <term><command>lpoptions</command></term>
397 <listitem>
398 <para>displays or sets printer options and defaults.</para>
399 <indexterm zone="cups lpoptions">
400 <primary sortas="b-lpoptions">lpoptions</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="lppasswd">
406 <term><command>lppasswd</command></term>
407 <listitem>
408 <para>adds, changes or deletes passwords in the
409 <application>CUPS</application> digest password file
410 <filename>passwd.md5</filename>.</para>
411 <indexterm zone="cups lppasswd">
412 <primary sortas="b-lppasswd">lppasswd</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="lpq-cups">
418 <term><command>lpq</command></term>
419 <listitem>
420 <para>shows the current print queue status on the named printer.</para>
421 <indexterm zone="cups lpq-cups">
422 <primary sortas="b-lpq">lpq</primary>
423 </indexterm>
424 </listitem>
425 </varlistentry>
426
427 <varlistentry id="lpr-cups">
428 <term><command>lpr</command></term>
429 <listitem>
430 <para>submits files for printing.</para>
431 <indexterm zone="cups lpr-cups">
432 <primary sortas="b-lpr">lpr</primary>
433 </indexterm>
434 </listitem>
435 </varlistentry>
436
437 <varlistentry id="lprm-cups">
438 <term><command>lprm</command></term>
439 <listitem>
440 <para>cancels print jobs that have been queued for printing.</para>
441 <indexterm zone="cups lprm-cups">
442 <primary sortas="b-lprm">lprm</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="lpstat-cups">
448 <term><command>lpstat</command></term>
449 <listitem>
450 <para>displays status information about the current classes, jobs,
451 and printers.</para>
452 <indexterm zone="cups lpstat-cups">
453 <primary sortas="b-lpstat">lpstat</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457
458 <varlistentry id="reject">
459 <term><command>reject</command></term>
460 <listitem>
461 <para>instructs the printing system to reject print jobs to the
462 specified destinations.</para>
463 <indexterm zone="cups reject">
464 <primary sortas="b-reject">reject</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 </variablelist>
470
471 </sect2>
472
473</sect1>
Note: See TracBrowser for help on using the repository browser.