source: pst/printing/cups.xml@ f2957d0

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 f2957d0 was f2957d0, checked in by Randy McMurchy <randy@…>, 13 years ago

Updated to CUPS-1.4.5

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