source: pst/printing/cups.xml@ f4b5ef9

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 f4b5ef9 was f4b5ef9, checked in by Andrew Benton <andy@…>, 12 years ago

tweaked the description of qt-faststart
thanks to Jeremy Huntwork

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

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