source: pst/printing/cups.xml@ 21a52665

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 21a52665 was 3e653fa8, checked in by Andrew Benton <andy@…>, 12 years ago

cups docdir fix

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

  • Property mode set to 100644
File size: 17.7 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 "e54ed09ede2340fc3014913333520fe4">
10 <!ENTITY cups-size "3.9 MB">
11 <!ENTITY cups-buildsize "91 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 &lfs70_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>Download (HTTP): <ulink url="&cups-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&cups-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &cups-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &cups-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &cups-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &cups-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <bridgehead renderas="sect3">Cups Dependencies</bridgehead>
62
63 <bridgehead renderas="sect4">Recommended</bridgehead>
64 <para role="recommended">
65 <xref linkend="libjpeg"/>,
66 <xref linkend="libpng"/>, and
67 <xref linkend="libtiff"/>
68 </para>
69
70 <bridgehead renderas="sect4">Optional</bridgehead>
71 <para role="optional"><!-- <xref linkend="pkgconfig"/>, -->
72 <xref linkend="tcpwrappers"/>,
73 <xref linkend="dbus"/>,
74 <xref linkend="libusb"/>,
75 <xref linkend="acl"/>,
76 <xref linkend="linux-pam"/>,
77 <xref linkend="openldap"/>,
78 <xref linkend="gnutls"/> or <xref linkend="openssl"/> (looked for in that
79 order), <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
80 <xref linkend="php"/>,
81 <xref linkend="gs"/>,
82 <xref linkend="python"/>,
83 <xref linkend="icedtea6"/> or <xref linkend="jdk"/>,
84 <ulink url="http://portland.freedesktop.org/wiki/">Xdg-utils</ulink>,
85 <ulink url="http://www.openslp.org/">OpenSLP</ulink>,
86 <ulink
87 url="http://packages.debian.org/unstable/source/libpaper">libpaper</ulink>,
88 <ulink url="http://www.easysw.com/htmldoc/">HTMLDOC</ulink>, and
89 <ulink url="http://valgrind.org/">Valgrind</ulink> (optionally used if
90 running the test suites)
91 </para>
92
93 <para condition="html" role="usernotes">User Notes:
94 <ulink url="&blfs-wiki;/cups"/></para>
95
96 </sect2>
97
98 <sect2 role="kernel" id="cups-kernel">
99 <title>Kernel Configuration</title>
100
101 <para>If you have a parallel printer enable the following options in your
102 kernel configuration and recompile the kernel:</para>
103
104<screen><literal>Device Drivers ---&gt;
105 [*] Parallel port support ---&gt;
106 [*] PC-style hardware
107...
108 Character devices ---&gt;
109 [*] Parallel printer support</literal></screen>
110
111 <note><para>If you have a USB printer there is a conflict between the
112 <application>Cups</application> <application>libusb</application>
113 backend and the kernel driver. If you want to use
114 <application>Cups</application> with <application>libusb</application>
115 support <emphasis>do not</emphasis> enable USB Printer support in your
116 kernel and remove the <option>--disable-libusb</option> when you
117 configure <application>Cups</application>.</para></note>
118
119 <para>If you want to use the kernel usblp driver enable the following
120 options in your kernel configuration and recompile the kernel:</para>
121
122<screen>Device Drivers ---&gt;
123 [*] USB support ---&gt;
124...
125Enable support for either UHCI or OHCI, not both:
126 [*] OHCI HCD support
127 [*] UHCI HCD (most Intel and VIA) support
128...
129 [*] USB Printer support</screen>
130
131 <indexterm zone="cups cups-kernel">
132 <primary sortas="d-cups">cups</primary>
133 </indexterm>
134
135 </sect2>
136
137 <sect2 role="installation">
138 <title>Installation of Cups</title>
139
140 <para>Create an <systemitem class="username">lp</systemitem> user, as
141 <application>Cups</application> will create some files owned by this user.
142 (The <systemitem class="username">lp</systemitem> user is the default used
143 by <application>Cups</application>, but may be changed to a different user
144 by passing a parameter to the <command>configure</command> script.) Use the
145 following command as the <systemitem class="username">root</systemitem>
146 user:</para>
147
148<screen role="root"><userinput>useradd -c "Print Service User" -d /dev/null -g lp -s /bin/false -u 9 lp</userinput></screen>
149
150 <para>Install <application>Cups</application> by running the
151 following commands:</para>
152
153<screen><userinput>sed -i 's#@CUPS_HTMLVIEW@#firefox#' desktop/cups.desktop.in &amp;&amp;
154./configure --localstatedir=/var --disable-libusb --with-rcdir=/tmp/cupsinit --with-docdir=/usr/share/doc/&cups-version; &amp;&amp;
155make</userinput></screen>
156
157 <para>To test the results, issue: <command>make check</command>. This will
158 run a basic test suite without any load testing. If you wish to run the
159 tests specifying non-default parameters, issue:
160 <command>make test</command>. Note that the <quote>torture load
161 testing</quote> test uses more resources than those displayed in the
162 prompt.</para>
163
164 <para>Now, as the <systemitem class="username">root</systemitem>
165 user:</para>
166
167<screen role="root"><userinput>make install &amp;&amp;
168rm -rf /tmp/cupsinit</userinput></screen>
169
170 <para>The <application>man</application> files are installed in compressed
171 (<filename class="extension">.gz</filename>) format. If desired, use the
172 following commands to uncompress them as the
173 <systemitem class="username">root</systemitem> user:</para>
174
175<screen role="root"><userinput>pushd /usr/share/man/ &amp;&amp;
176find -name cups\*gz -type l -print -delete &amp;&amp;
177find -name \*gz -exec gunzip -v {} \; &amp;&amp;
178popd &amp;&amp;
179
180ln -v -s cupsaccept.8 /usr/share/man/man8/reject.8 &amp;&amp;
181ln -v -s cupsaccept.8 /usr/share/man/man8/cupsreject.8 &amp;&amp;
182ln -v -s cupsaccept.8 /usr/share/man/man8/accept.8 &amp;&amp;
183ln -v -s cupsenable.8 /usr/share/man/man8/cupsdisable.8</userinput></screen>
184
185 </sect2>
186
187 <sect2 role="commands">
188 <title>Command Explanations</title>
189
190 <para><command>sed -i 's#@CUPS_HTMLVIEW@#firefox#' ...</command>: This
191 changes the browser that the <application>Cups</application> desktop file
192 uses for its web interface.</para>
193
194 <para><option>--localstatedir=/var</option>: This changes the location of
195 the cache, log, run and spool directories from /usr/var to /var.</para>
196
197 <para><option>--disable-libusb</option>: This disables the
198 <application>Cups</application> <application>libusb</application> backend.
199 If you&apos;d like <application>Cups</application> to use
200 <application>libusb</application>, delete this option and make sure you
201 compile your kernel with: # CONFIG_USB_PRINTER is not set</para>
202
203 <para><option>--with-rcdir=/tmp/cupsinit</option>: This option makes it install its
204 bootscript into <filename class="directory">/tmp</filename> instead of
205 <filename class="directory">/etc/rc.d</filename>.</para>
206
207 </sect2>
208
209 <sect2 role="configuration">
210 <title>Configuring Cups</title>
211
212 <para>Configuration of <application>Cups</application> is dependent on
213 the type of printer and can be complex. Generally, PostScript printers
214 are easier. For detailed instructions on configuration and use of
215 <application>Cups</application>, see <ulink
216 url="http://www.cups.org/documentation.php"/>. The Software Administrators
217 Manual and Software Users Manual are particularly useful.</para>
218
219 <para>For non-PostScript printers to print with
220 <application>Cups</application>, you need to install <xref linkend="gs"/>
221 to convert PostScript to raster images and a driver (e.g., from
222 <xref linkend="gutenprint"/>) to convert the resulting raster images to a
223 form that the printer understands.
224 <ulink url="http://www.linuxprinting.org/foomatic.html">Foomatic</ulink>
225 drivers use Ghostscript to convert PostScript to a printable form directly,
226 but this is considered to be a hack by
227 <application>Cups</application> developers.</para>
228
229 <sect3 id="cups-init">
230 <title>Boot Script</title>
231
232 <para>If you want the <application>Cups</application> to start
233 automatically when the system is booted, install the init script included
234 in the <xref linkend="bootscripts"/> package:</para>
235
236 <indexterm zone="cups cups-init">
237 <primary sortas="f-cups">cups</primary>
238 </indexterm>
239
240<screen role="root"><userinput>make install-cups</userinput></screen>
241
242 </sect3>
243
244 </sect2>
245
246 <sect2 role="content">
247 <title>Contents</title>
248
249 <segmentedlist>
250 <segtitle>Installed Programs</segtitle>
251 <segtitle>Installed Libraries</segtitle>
252 <segtitle>Installed Directories</segtitle>
253
254 <seglistitem>
255 <seg>accept, cancel, cups-config, cupsaccept, cupsaddsmb, cupsctl,
256 cupsd, cupsdisable, cupsenable, cupsfilter, cupsreject, cupstestdsc,
257 cupstestppd, lp, lpadmin, lpc, lpinfo, lpmove, lpoptions, lppasswd,
258 lpq, lpr, lprm, lpstat, ppdc, ppdhtml, ppdi, ppdmerge, ppdpo,
259 reject</seg>
260 <seg>libcups.so, libcupscgi.so, libcupsdriver.so,
261 libcupsimage.so, libcupsmime.so, libcupsppdc.so, and
262 various filters and backend drivers</seg>
263 <seg>/etc/cups, /usr/include/cups, /usr/lib/cups, /usr/share/cups,
264 /usr/share/doc/cups-&cups-version;, /var/cache/cups, /var/log/cups,
265 /var/run/cups and /var/spool/cups.</seg>
266 </seglistitem>
267 </segmentedlist>
268
269 <variablelist>
270 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
271 <?dbfo list-presentation="list"?>
272 <?dbhtml list-presentation="table"?>
273
274 <varlistentry id="accept">
275 <term><command>accept</command></term>
276 <listitem>
277 <para>instructs the printing system to accept print jobs to the
278 specified destinations.</para>
279 <indexterm zone="cups accept">
280 <primary sortas="b-accept">accept</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="cancel-cups">
286 <term><command>cancel</command></term>
287 <listitem>
288 <para>cancels existing print jobs from the print queues.</para>
289 <indexterm zone="cups cancel-cups">
290 <primary sortas="b-cancel">cancel</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="cups-config">
296 <term><command>cups-config</command></term>
297 <listitem>
298 <para>is a <application>Cups</application>
299 program configuration utility.</para>
300 <indexterm zone="cups cups-config">
301 <primary sortas="b-cups-config">cups-config</primary>
302 </indexterm>
303 </listitem>
304 </varlistentry>
305
306 <varlistentry id="cupsaddsmb">
307 <term><command>cupsaddsmb</command></term>
308 <listitem>
309 <para>exports printers to the <application>Samba</application>
310 software for use with Windows clients.</para>
311 <indexterm zone="cups cupsaddsmb">
312 <primary sortas="b-cupsaddsmb">cupsaddsmb</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="cupsd">
318 <term><command>cupsd</command></term>
319 <listitem>
320 <para>is the scheduler for the Common Unix Printing System.</para>
321 <indexterm zone="cups cupsd">
322 <primary sortas="b-cupsd">cupsd</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="cupstestppd">
328 <term><command>cupstestppd</command></term>
329 <listitem>
330 <para>tests the conformance of PPD files.</para>
331 <indexterm zone="cups cupstestppd">
332 <primary sortas="b-cupstestppd">cupstestppd</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="disable">
338 <term><command>disable</command></term>
339 <listitem>
340 <para>stops the named printers or classes.</para>
341 <indexterm zone="cups disable">
342 <primary sortas="b-disable">disable</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="enable">
348 <term><command>enable</command></term>
349 <listitem>
350 <para>starts the named printers or classes.</para>
351 <indexterm zone="cups enable">
352 <primary sortas="b-enable">enable</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="lp-cups">
358 <term><command>lp</command></term>
359 <listitem>
360 <para>submits files for printing or alters a pending job.</para>
361 <indexterm zone="cups lp-cups">
362 <primary sortas="b-lp">lp</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="lpadmin">
368 <term><command>lpadmin</command></term>
369 <listitem>
370 <para>configures printer and class queues provided by
371 <application>Cups</application>.</para>
372 <indexterm zone="cups lpadmin">
373 <primary sortas="b-lpadmin">lpadmin</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="lpc-cups">
379 <term><command>lpc</command></term>
380 <listitem>
381 <para> provides limited control over printer and class queues
382 provided by <application>Cups</application>.</para>
383 <indexterm zone="cups lpc-cups">
384 <primary sortas="b-lpc">lpc</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="lpinfo">
390 <term><command>lpinfo</command></term>
391 <listitem>
392 <para>lists the available devices or drivers known to the
393 <application>Cups</application> server.</para>
394 <indexterm zone="cups lpinfo">
395 <primary sortas="b-lpinfo">lpinfo</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="lpmove">
401 <term><command>lpmove</command></term>
402 <listitem>
403 <para>moves the specified job to a new destination.</para>
404 <indexterm zone="cups lpmove">
405 <primary sortas="b-lpmove">lpmove</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="lpoptions">
411 <term><command>lpoptions</command></term>
412 <listitem>
413 <para>displays or sets printer options and defaults.</para>
414 <indexterm zone="cups lpoptions">
415 <primary sortas="b-lpoptions">lpoptions</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="lppasswd">
421 <term><command>lppasswd</command></term>
422 <listitem>
423 <para>adds, changes or deletes passwords in the
424 <application>Cups</application> digest password file
425 <filename>passwd.md5</filename>.</para>
426 <indexterm zone="cups lppasswd">
427 <primary sortas="b-lppasswd">lppasswd</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="lpq-cups">
433 <term><command>lpq</command></term>
434 <listitem>
435 <para>shows the current print queue status on the named printer.</para>
436 <indexterm zone="cups lpq-cups">
437 <primary sortas="b-lpq">lpq</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="lpr-cups">
443 <term><command>lpr</command></term>
444 <listitem>
445 <para>submits files for printing.</para>
446 <indexterm zone="cups lpr-cups">
447 <primary sortas="b-lpr">lpr</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="lprm-cups">
453 <term><command>lprm</command></term>
454 <listitem>
455 <para>cancels print jobs that have been queued for printing.</para>
456 <indexterm zone="cups lprm-cups">
457 <primary sortas="b-lprm">lprm</primary>
458 </indexterm>
459 </listitem>
460 </varlistentry>
461
462 <varlistentry id="lpstat-cups">
463 <term><command>lpstat</command></term>
464 <listitem>
465 <para>displays status information about the current classes, jobs,
466 and printers.</para>
467 <indexterm zone="cups lpstat-cups">
468 <primary sortas="b-lpstat">lpstat</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="reject">
474 <term><command>reject</command></term>
475 <listitem>
476 <para>instructs the printing system to reject print jobs to the
477 specified destinations.</para>
478 <indexterm zone="cups reject">
479 <primary sortas="b-reject">reject</primary>
480 </indexterm>
481 </listitem>
482 </varlistentry>
483
484 </variablelist>
485
486 </sect2>
487
488</sect1>
Note: See TracBrowser for help on using the repository browser.