source: pst/printing/cups.xml@ fd44c92

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 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 fd44c92 was fd44c92, checked in by Randy McMurchy <randy@…>, 19 years ago

Updated text about the CUPS test suite

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

  • Property mode set to 100644
File size: 15.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/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 "4ce09b1dce09b6b9398af0daae9adf63">
10 <!ENTITY cups-size "8.7 MB">
11 <!ENTITY cups-buildsize "48 MB">
12 <!ENTITY cups-time "0.5 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>Recommended patch: <ulink
63 url="&patch-root;/cups-&cups-version;-testsuite_fix-1.patch"/></para>
64 </listitem>
65 </itemizedlist>
66
67 <bridgehead renderas="sect3">CUPS Dependencies</bridgehead>
68
69 <bridgehead renderas="sect4">Recommended</bridgehead>
70 <para><xref linkend="libjpeg"/>,
71 <xref linkend="libpng"/>,
72 and <xref linkend="libtiff"/></para>
73
74 <bridgehead renderas="sect4">Optional</bridgehead>
75 <para><xref linkend="openssl"/> or
76 <ulink url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink> (which needs
77 <ulink url="ftp://ftp.gnupg.org/gcrypt/alpha/libgpg-error/">
78 libgpg-error</ulink>,
79 <ulink url="ftp://ftp.gnupg.org/gcrypt/libgcrypt/">libgcrypt</ulink> and
80 <ulink url="ftp://ftp.gnupg.org/gcrypt/alpha/gnutls/opencdk/">opencdk</ulink>,
81 in that order),
82 <xref linkend="Linux_PAM"/>,
83 <xref linkend="php"/>,
84 <xref linkend="python"/>,
85 <xref linkend="jdk"/>,
86 <ulink url="http://www.openslp.org/">OpenSLP</ulink>,
87 <ulink url="http://packages.debian.org/unstable/source/libpaper">
88 libpaper</ulink> and
89 <ulink url="http://valgrind.kde.org/">Valgrind</ulink> (optionally used if
90 running the test suites)</para>
91
92 </sect2>
93
94 <sect2 role="installation">
95 <title>Installation of CUPS</title>
96
97 <para>Create an <systemitem class="username">lp</systemitem> user, as
98 <application>CUPS</application> will install the
99 <command>lppasswd</command> command SUID to this user. Use the following
100 command as the <systemitem class="username">root</systemitem> user:</para>
101
102<screen role="root"><userinput>useradd -c "Print Service User" -d /dev/null -g lp -s /bin/false -u 9 lp</userinput></screen>
103
104 <para>If you utilize <application>Linux-PAM</application>, you need to
105 modify some files so <application>CUPS</application> can find needed headers.
106 Make the appropriate modifications using the following command:</para>
107
108<screen><userinput>sed -i -e "s@pam/pam@security/pam@g" \
109{config-scripts/cups-pam.m4,scheduler/auth.c,configure}</userinput></screen>
110
111 <para>If you plan on running the test suite, you should apply the patch
112 listed above to fix several issues in the test suite script. Note that if
113 you have the non-free <command>htmldoc</command> program installed, the
114 patch disables its use.</para>
115
116 <screen><userinput>patch -Np1 -i ../cups-&cups-version;-testsuite_fix-1.patch</userinput></screen>
117
118 <para>Install <application>CUPS</application> by running the
119 following commands:</para>
120
121<screen><userinput>./configure &amp;&amp;
122make</userinput></screen>
123
124 <para>To test the results, issue: <command>make check</command>. Note that
125 the <quote>torture load testing</quote> test uses more resources than those
126 displayed in the prompt.</para>
127
128 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
129
130<screen role="root"><userinput>make install</userinput></screen>
131
132 </sect2>
133
134 <sect2 role="commands">
135 <title>Command Explanations</title>
136
137 <para>The basic default behavior of the installation is appropriate for
138 LFS systems. <application>CUPS</application> files are placed in
139 <filename class="directory">/usr/bin</filename>,
140 <filename class="directory">/usr/sbin</filename>,
141 <filename class="directory">/var</filename> and
142 <filename class="directory">/etc/cups</filename>.</para>
143
144 </sect2>
145
146 <sect2 role="configuration">
147 <title>Configuring CUPS</title>
148
149 <para>Configuration of <application>CUPS</application> is dependent on
150 the type of printer and can be complex. Generally, PostScript printers
151 are easier. For detailed instructions on configuration and use of
152 <application>CUPS</application>, see <ulink
153 url="http://www.cups.org/documentation.php"/>. The Software Administrators
154 Manual and Software Users Manual are particularly useful.</para>
155
156 <para>For non-PostScript printers to print with
157 <application>CUPS</application>, you need to install
158 <xref linkend="espgs"/> to convert PostScript to raster images
159 and a driver (e.g., from <xref linkend="gimp-print"/>) to convert
160 the resulting raster images to a form that the printer understands.
161 <ulink url="http://www.linuxprinting.org/foomatic.html">Foomatic</ulink>
162 drivers use Ghostscript to convert PostScript to a printable form directly,
163 but this is considered to be a hack by
164 <application>CUPS</application> developers.</para>
165
166 <sect3 id="cups-init">
167 <title>Boot Script</title>
168
169 <para>During the installation, <application>CUPS</application> added
170 startup files in <filename class="directory">/etc/rc.d</filename>.
171 These scripts will work in most cases, but will fail if you provide
172 printers to <application>Samba</application> clients. Additionally,
173 they are not consistent with standard LFS style scripts. Replace the
174 installed scripts with the scripts and symlinks included in the
175 <xref linkend="intro-important-bootscripts"/> package:</para>
176
177 <indexterm zone="cups cups-init">
178 <primary sortas="f-cups">cups</primary>
179 </indexterm>
180
181<screen role="root"><userinput>make install-cups</userinput></screen>
182
183 </sect3>
184
185 </sect2>
186
187 <sect2 role="content">
188 <title>Contents</title>
189
190 <segmentedlist>
191 <segtitle>Installed Programs</segtitle>
192 <segtitle>Installed Libraries</segtitle>
193 <segtitle>Installed Directories</segtitle>
194
195 <seglistitem>
196 <seg>accept, cancel, cups-config, cupsaddsmb, cupsd, cupstestppd, disable,
197 enable, lp, lpadmin, lpc, lpinfo, lpmove, lpoptions, lppasswd, lpq, lpr,
198 lprm, lpstat, and reject</seg>
199 <seg>libcups.[so,a], libcupsimage.[so,a], and various filters and backend
200 drivers</seg>
201 <seg>/etc/cups, /usr/include/cups, /usr/lib/cups, /usr/share/doc/cups,
202 /usr/share/cups, /var/log/cups, and /var/spool/cups</seg>
203 </seglistitem>
204 </segmentedlist>
205
206 <variablelist>
207 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
208 <?dbfo list-presentation="list"?>
209 <?dbhtml list-presentation="table"?>
210
211 <varlistentry id="accept">
212 <term><command>accept</command></term>
213 <listitem>
214 <para>instructs the printing system to accept print jobs to the
215 specified destinations.</para>
216 <indexterm zone="cups accept">
217 <primary sortas="b-accept">accept</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="cancel-cups">
223 <term><command>cancel</command></term>
224 <listitem>
225 <para>cancels existing print jobs from the print queues.</para>
226 <indexterm zone="cups cancel-cups">
227 <primary sortas="b-cancel">cancel</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="cups-config">
233 <term><command>cups-config</command></term>
234 <listitem>
235 <para>is a <application>CUPS</application>
236 program configuration utility.</para>
237 <indexterm zone="cups cups-config">
238 <primary sortas="b-cups-config">cups-config</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="cupsaddsmb">
244 <term><command>cupsaddsmb</command></term>
245 <listitem>
246 <para>exports printers to the <application>Samba</application>
247 software for use with Windows clients.</para>
248 <indexterm zone="cups cupsaddsmb">
249 <primary sortas="b-cupsaddsmb">cupsaddsmb</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="cupsd">
255 <term><command>cupsd</command></term>
256 <listitem>
257 <para>is the scheduler for the Common Unix Printing System.</para>
258 <indexterm zone="cups cupsd">
259 <primary sortas="b-cupsd">cupsd</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="cupstestppd">
265 <term><command>cupstestppd</command></term>
266 <listitem>
267 <para>tests the conformance of PPD files.</para>
268 <indexterm zone="cups cupstestppd">
269 <primary sortas="b-cupstestppd">cupstestppd</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="disable">
275 <term><command>disable</command></term>
276 <listitem>
277 <para>stops the named printers or classes.</para>
278 <indexterm zone="cups disable">
279 <primary sortas="b-disable">disable</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="enable">
285 <term><command>enable</command></term>
286 <listitem>
287 <para>starts the named printers or classes.</para>
288 <indexterm zone="cups enable">
289 <primary sortas="b-enable">enable</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="lp-cups">
295 <term><command>lp</command></term>
296 <listitem>
297 <para>submits files for printing or alters a pending job.</para>
298 <indexterm zone="cups lp-cups">
299 <primary sortas="b-lp">lp</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="lpadmin">
305 <term><command>lpadmin</command></term>
306 <listitem>
307 <para>configures printer and class queues provided by
308 <application>CUPS</application>.</para>
309 <indexterm zone="cups lpadmin">
310 <primary sortas="b-lpadmin">lpadmin</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="lpc-cups">
316 <term><command>lpc</command></term>
317 <listitem>
318 <para> provides limited control over printer and class queues
319 provided by <application>CUPS</application>.</para>
320 <indexterm zone="cups lpc-cups">
321 <primary sortas="b-lpc">lpc</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="lpinfo">
327 <term><command>lpinfo</command></term>
328 <listitem>
329 <para>lists the available devices or drivers known to the
330 <application>CUPS</application> server.</para>
331 <indexterm zone="cups lpinfo">
332 <primary sortas="b-lpinfo">lpinfo</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="lpmove">
338 <term><command>lpmove</command></term>
339 <listitem>
340 <para>moves the specified job to a new destination.</para>
341 <indexterm zone="cups lpmove">
342 <primary sortas="b-lpmove">lpmove</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="lpoptions">
348 <term><command>lpoptions</command></term>
349 <listitem>
350 <para>displays or sets printer options and defaults.</para>
351 <indexterm zone="cups lpoptions">
352 <primary sortas="b-lpoptions">lpoptions</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="lppasswd">
358 <term><command>lppasswd</command></term>
359 <listitem>
360 <para>adds, changes or deletes passwords in the
361 <application>CUPS</application> digest password file
362 <filename>passwd.md5</filename>.</para>
363 <indexterm zone="cups lppasswd">
364 <primary sortas="b-lppasswd">lppasswd</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="lpq-cups">
370 <term><command>lpq</command></term>
371 <listitem>
372 <para>shows the current print queue status on the named printer.</para>
373 <indexterm zone="cups lpq-cups">
374 <primary sortas="b-lpq">lpq</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="lpr-cups">
380 <term><command>lpr</command></term>
381 <listitem>
382 <para>submits files for printing.</para>
383 <indexterm zone="cups lpr-cups">
384 <primary sortas="b-lpr">lpr</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="lprm-cups">
390 <term><command>lprm</command></term>
391 <listitem>
392 <para>cancels print jobs that have been queued for printing.</para>
393 <indexterm zone="cups lprm-cups">
394 <primary sortas="b-lprm">lprm</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="lpstat-cups">
400 <term><command>lpstat</command></term>
401 <listitem>
402 <para>displays status information about the current classes, jobs,
403 and printers.</para>
404 <indexterm zone="cups lpstat-cups">
405 <primary sortas="b-lpstat">lpstat</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="reject">
411 <term><command>reject</command></term>
412 <listitem>
413 <para>instructs the printing system to reject print jobs to the
414 specified destinations.</para>
415 <indexterm zone="cups reject">
416 <primary sortas="b-reject">reject</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 </variablelist>
422
423 </sect2>
424
425</sect1>
Note: See TracBrowser for help on using the repository browser.