source: pst/printing/cups.xml@ d5eb6934

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

Added two optional dependencies for the CUPS package

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

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