source: pst/printing/cups.xml@ 802395e

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 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 802395e was 802395e, checked in by Ken Moffat <ken@…>, 16 years ago

Reference the correct patch when applying it. Thanks to Randy for noticing this.

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

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