source: pst/printing/cups.xml@ 4293ad15

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 4293ad15 was 80cec50, checked in by Chris Staub <chris@…>, 16 years ago

Add kernel config info to CUPS page

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

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