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