| 1 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
|---|
| 2 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
|---|
| 3 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 4 | %general-entities;
|
|---|
| 5 |
|
|---|
| 6 | <!ENTITY cups-download-http "http://ftp.easysw.com/pub/cups/&cups-version;/cups-&cups-version;-source.tar.bz2">
|
|---|
| 7 | <!ENTITY cups-download-ftp "ftp://ftp.easysw.com/pub/cups/&cups-version;/cups-&cups-version;-source.tar.bz2">
|
|---|
| 8 | <!ENTITY cups-md5sum "4ce09b1dce09b6b9398af0daae9adf63">
|
|---|
| 9 | <!ENTITY cups-size "8.7 MB">
|
|---|
| 10 | <!ENTITY cups-buildsize "48 MB">
|
|---|
| 11 | <!ENTITY cups-time "0.52 SBU (additional 69 SBU to run full test suite)">
|
|---|
| 12 | ]>
|
|---|
| 13 |
|
|---|
| 14 | <sect1 id="cups" xreflabel="CUPS-&cups-version;">
|
|---|
| 15 | <?dbhtml filename="cups.html"?>
|
|---|
| 16 |
|
|---|
| 17 | <sect1info>
|
|---|
| 18 | <othername>$LastChangedBy$</othername>
|
|---|
| 19 | <date>$Date$</date>
|
|---|
| 20 | </sect1info>
|
|---|
| 21 |
|
|---|
| 22 | <title>CUPS-&cups-version;</title>
|
|---|
| 23 |
|
|---|
| 24 | <indexterm zone="cups">
|
|---|
| 25 | <primary sortas="a-CUPS">CUPS</primary>
|
|---|
| 26 | </indexterm>
|
|---|
| 27 |
|
|---|
| 28 | <sect2 role="package">
|
|---|
| 29 | <title>Introduction to CUPS</title>
|
|---|
| 30 |
|
|---|
| 31 | <para>The Common Unix Printing System (CUPS) is a print spooler and
|
|---|
| 32 | associated utilities. It is based on the "Internet Printing
|
|---|
| 33 | Protocol" and provides printing services to most PostScript and raster
|
|---|
| 34 | printers.</para>
|
|---|
| 35 |
|
|---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 37 | <itemizedlist spacing="compact">
|
|---|
| 38 | <listitem>
|
|---|
| 39 | <para>Download (HTTP): <ulink url="&cups-download-http;"/></para>
|
|---|
| 40 | </listitem>
|
|---|
| 41 | <listitem>
|
|---|
| 42 | <para>Download (FTP): <ulink url="&cups-download-ftp;"/></para>
|
|---|
| 43 | </listitem>
|
|---|
| 44 | <listitem>
|
|---|
| 45 | <para>Download MD5 sum: &cups-md5sum;</para>
|
|---|
| 46 | </listitem>
|
|---|
| 47 | <listitem>
|
|---|
| 48 | <para>Download size: &cups-size;</para>
|
|---|
| 49 | </listitem>
|
|---|
| 50 | <listitem>
|
|---|
| 51 | <para>Estimated disk space required: &cups-buildsize;</para>
|
|---|
| 52 | </listitem>
|
|---|
| 53 | <listitem>
|
|---|
| 54 | <para>Estimated build time: &cups-time;</para>
|
|---|
| 55 | </listitem>
|
|---|
| 56 | </itemizedlist>
|
|---|
| 57 |
|
|---|
| 58 | <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
|
|---|
| 59 |
|
|---|
| 60 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 61 | <para><xref linkend="libjpeg"/>,
|
|---|
| 62 | <xref linkend="libpng"/>,
|
|---|
| 63 | and <xref linkend="libtiff"/></para>
|
|---|
| 64 |
|
|---|
| 65 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 66 | <para><xref linkend="openssl"/> or
|
|---|
| 67 | <ulink url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink> (which needs
|
|---|
| 68 | <ulink url="ftp://ftp.gnupg.org/gcrypt/alpha/libgpg-error/">
|
|---|
| 69 | libgpg-error</ulink>,
|
|---|
| 70 | <ulink url="ftp://ftp.gnupg.org/gcrypt/libgcrypt/">libgcrypt</ulink> and
|
|---|
| 71 | <ulink url="ftp://ftp.gnupg.org/gcrypt/alpha/gnutls/opencdk/">opencdk</ulink>,
|
|---|
| 72 | in that order),
|
|---|
| 73 | <xref linkend="Linux_PAM"/>,
|
|---|
| 74 | <xref linkend="php"/>,
|
|---|
| 75 | <xref linkend="python"/>,
|
|---|
| 76 | <xref linkend="jdk"/>,
|
|---|
| 77 | <ulink url="http://www.openslp.org/">OpenSLP</ulink>,
|
|---|
| 78 | <ulink url="http://packages.debian.org/unstable/source/libpaper">
|
|---|
| 79 | libpaper</ulink> and
|
|---|
| 80 | <ulink url="http://valgrind.kde.org/">Valgrind</ulink> (optionally used if
|
|---|
| 81 | running the test suites)</para>
|
|---|
| 82 |
|
|---|
| 83 | </sect2>
|
|---|
| 84 |
|
|---|
| 85 | <sect2 role="installation">
|
|---|
| 86 | <title>Installation of CUPS</title>
|
|---|
| 87 |
|
|---|
| 88 | <para>Create an <systemitem class="username">lp</systemitem> user, as
|
|---|
| 89 | <application>CUPS</application> will install the
|
|---|
| 90 | <command>lppasswd</command> command SUID to this user. Use the following
|
|---|
| 91 | command as the <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 92 |
|
|---|
| 93 | <screen role="root"><userinput>useradd -c "Print Service User" -d /dev/null -g lp -s /bin/false lp</userinput></screen>
|
|---|
| 94 |
|
|---|
| 95 | <para>If you utilize <application>Linux-PAM</application>, you need to
|
|---|
| 96 | modify some files so <application>CUPS</application> can find needed headers.
|
|---|
| 97 | Make the appropriate modifications using the following command:</para>
|
|---|
| 98 |
|
|---|
| 99 | <screen><userinput>sed -i -e "s@pam/pam@security/pam@g" \
|
|---|
| 100 | {config-scripts/cups-pam.m4,scheduler/auth.c,configure}</userinput></screen>
|
|---|
| 101 |
|
|---|
| 102 | <para>Install <application>CUPS</application> by running the
|
|---|
| 103 | following commands:</para>
|
|---|
| 104 |
|
|---|
| 105 | <screen><userinput>./configure &&
|
|---|
| 106 | make</userinput></screen>
|
|---|
| 107 |
|
|---|
| 108 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 109 |
|
|---|
| 110 | <screen role="root"><userinput>make install</userinput></screen>
|
|---|
| 111 |
|
|---|
| 112 | </sect2>
|
|---|
| 113 |
|
|---|
| 114 | <sect2 role="commands">
|
|---|
| 115 | <title>Command Explanations</title>
|
|---|
| 116 |
|
|---|
| 117 | <para>The basic default behavior of the installation is appropriate for
|
|---|
| 118 | LFS systems. <application>CUPS</application> files are placed in
|
|---|
| 119 | <filename class="directory">/usr/bin</filename>,
|
|---|
| 120 | <filename class="directory">/usr/sbin</filename>,
|
|---|
| 121 | <filename class="directory">/var</filename> and
|
|---|
| 122 | <filename class="directory">/etc/cups</filename>.</para>
|
|---|
| 123 |
|
|---|
| 124 | </sect2>
|
|---|
| 125 |
|
|---|
| 126 | <sect2 role="configuration">
|
|---|
| 127 | <title>Configuring CUPS</title>
|
|---|
| 128 |
|
|---|
| 129 | <para>Configuration of <application>CUPS</application> is dependent on
|
|---|
| 130 | the type of printer and can be complex. Generally, PostScript printers
|
|---|
| 131 | are easier. For detailed instructions on configuration and use of
|
|---|
| 132 | <application>CUPS</application>, see <ulink
|
|---|
| 133 | url="http://www.cups.org/documentation.php"/>. The Software Administrators
|
|---|
| 134 | Manual and Software Users Manual are particularly useful.</para>
|
|---|
| 135 |
|
|---|
| 136 | <para>For non-PostScript printers to print with
|
|---|
| 137 | <application>CUPS</application>, you need to install
|
|---|
| 138 | <xref linkend="espgs"/> to convert PostScript to raster images
|
|---|
| 139 | and a driver (e.g., from <xref linkend="gimp-print"/>) to convert
|
|---|
| 140 | the resulting raster images to a form that the printer understands.
|
|---|
| 141 | <ulink url="http://www.linuxprinting.org/foomatic.html">Foomatic</ulink>
|
|---|
| 142 | drivers use Ghostscript to convert PostScript to a printable form directly,
|
|---|
| 143 | but this is considered to be a hack by
|
|---|
| 144 | <application>CUPS</application> developers.</para>
|
|---|
| 145 |
|
|---|
| 146 | <sect3 id="cups-init">
|
|---|
| 147 | <title>Boot Script</title>
|
|---|
| 148 |
|
|---|
| 149 | <para>During the install, <application>CUPS</application> created
|
|---|
| 150 | the startup file <command>/etc/rc.d/init.d/cups</command>. The file
|
|---|
| 151 | works, but you may want to change it to a more conventional
|
|---|
| 152 | LFS startup file by installing the script included in the
|
|---|
| 153 | <xref linkend="intro-important-bootscripts"/> package:</para>
|
|---|
| 154 |
|
|---|
| 155 | <indexterm zone="cups cups-init">
|
|---|
| 156 | <primary sortas="f-cups">cups</primary>
|
|---|
| 157 | </indexterm>
|
|---|
| 158 |
|
|---|
| 159 | <screen role="root"><userinput>make install-cups</userinput></screen>
|
|---|
| 160 |
|
|---|
| 161 | </sect3>
|
|---|
| 162 |
|
|---|
| 163 | </sect2>
|
|---|
| 164 |
|
|---|
| 165 | <sect2 role="content">
|
|---|
| 166 | <title>Contents</title>
|
|---|
| 167 |
|
|---|
| 168 | <segmentedlist>
|
|---|
| 169 | <segtitle>Installed Programs</segtitle>
|
|---|
| 170 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 171 | <segtitle>Installed Directories</segtitle>
|
|---|
| 172 |
|
|---|
| 173 | <seglistitem>
|
|---|
| 174 | <seg>accept, cancel, cups-config, cupsaddsmb, cupsd, cupstestppd, disable,
|
|---|
| 175 | enable, lp, lpadmin, lpc, lpinfo, lpmove, lpoptions, lppasswd, lpq, lpr,
|
|---|
| 176 | lprm, lpstat, and reject</seg>
|
|---|
| 177 | <seg>libcups.[so,a], libcupsimage.[so,a], and various filters and backend
|
|---|
| 178 | drivers</seg>
|
|---|
| 179 | <seg>/etc/cups, /usr/include/cups, /usr/lib/cups, /usr/share/doc/cups,
|
|---|
| 180 | /usr/share/cups, /var/log/cups, and /var/spool/cups</seg>
|
|---|
| 181 | </seglistitem>
|
|---|
| 182 | </segmentedlist>
|
|---|
| 183 |
|
|---|
| 184 | <variablelist>
|
|---|
| 185 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 186 | <?dbfo list-presentation="list"?>
|
|---|
| 187 | <?dbhtml list-presentation="table"?>
|
|---|
| 188 |
|
|---|
| 189 | <varlistentry id="accept">
|
|---|
| 190 | <term><command>accept</command></term>
|
|---|
| 191 | <listitem>
|
|---|
| 192 | <para>instructs the printing system to accept print jobs to the
|
|---|
| 193 | specified destinations.</para>
|
|---|
| 194 | <indexterm zone="cups accept">
|
|---|
| 195 | <primary sortas="b-accept">accept</primary>
|
|---|
| 196 | </indexterm>
|
|---|
| 197 | </listitem>
|
|---|
| 198 | </varlistentry>
|
|---|
| 199 |
|
|---|
| 200 | <varlistentry id="cancel-cups">
|
|---|
| 201 | <term><command>cancel</command></term>
|
|---|
| 202 | <listitem>
|
|---|
| 203 | <para>cancels existing print jobs from the print queues.</para>
|
|---|
| 204 | <indexterm zone="cups cancel-cups">
|
|---|
| 205 | <primary sortas="b-cancel">cancel</primary>
|
|---|
| 206 | </indexterm>
|
|---|
| 207 | </listitem>
|
|---|
| 208 | </varlistentry>
|
|---|
| 209 |
|
|---|
| 210 | <varlistentry id="cups-config">
|
|---|
| 211 | <term><command>cups-config</command></term>
|
|---|
| 212 | <listitem>
|
|---|
| 213 | <para>is a <application>CUPS</application>
|
|---|
| 214 | program configuration utility.</para>
|
|---|
| 215 | <indexterm zone="cups cups-config">
|
|---|
| 216 | <primary sortas="b-cups-config">cups-config</primary>
|
|---|
| 217 | </indexterm>
|
|---|
| 218 | </listitem>
|
|---|
| 219 | </varlistentry>
|
|---|
| 220 |
|
|---|
| 221 | <varlistentry id="cupsaddsmb">
|
|---|
| 222 | <term><command>cupsaddsmb</command></term>
|
|---|
| 223 | <listitem>
|
|---|
| 224 | <para>exports printers to the <application>Samba</application>
|
|---|
| 225 | software for use with Windows clients.</para>
|
|---|
| 226 | <indexterm zone="cups cupsaddsmb">
|
|---|
| 227 | <primary sortas="b-cupsaddsmb">cupsaddsmb</primary>
|
|---|
| 228 | </indexterm>
|
|---|
| 229 | </listitem>
|
|---|
| 230 | </varlistentry>
|
|---|
| 231 |
|
|---|
| 232 | <varlistentry id="cupsd">
|
|---|
| 233 | <term><command>cupsd</command></term>
|
|---|
| 234 | <listitem>
|
|---|
| 235 | <para>is the scheduler for the Common Unix Printing System.</para>
|
|---|
| 236 | <indexterm zone="cups cupsd">
|
|---|
| 237 | <primary sortas="b-cupsd">cupsd</primary>
|
|---|
| 238 | </indexterm>
|
|---|
| 239 | </listitem>
|
|---|
| 240 | </varlistentry>
|
|---|
| 241 |
|
|---|
| 242 | <varlistentry id="cupstestppd">
|
|---|
| 243 | <term><command>cupstestppd</command></term>
|
|---|
| 244 | <listitem>
|
|---|
| 245 | <para>tests the conformance of PPD files.</para>
|
|---|
| 246 | <indexterm zone="cups cupstestppd">
|
|---|
| 247 | <primary sortas="b-cupstestppd">cupstestppd</primary>
|
|---|
| 248 | </indexterm>
|
|---|
| 249 | </listitem>
|
|---|
| 250 | </varlistentry>
|
|---|
| 251 |
|
|---|
| 252 | <varlistentry id="disable">
|
|---|
| 253 | <term><command>disable</command></term>
|
|---|
| 254 | <listitem>
|
|---|
| 255 | <para>stops the named printers or classes.</para>
|
|---|
| 256 | <indexterm zone="cups disable">
|
|---|
| 257 | <primary sortas="b-disable">disable</primary>
|
|---|
| 258 | </indexterm>
|
|---|
| 259 | </listitem>
|
|---|
| 260 | </varlistentry>
|
|---|
| 261 |
|
|---|
| 262 | <varlistentry id="enable">
|
|---|
| 263 | <term><command>enable</command></term>
|
|---|
| 264 | <listitem>
|
|---|
| 265 | <para>starts the named printers or classes.</para>
|
|---|
| 266 | <indexterm zone="cups enable">
|
|---|
| 267 | <primary sortas="b-enable">enable</primary>
|
|---|
| 268 | </indexterm>
|
|---|
| 269 | </listitem>
|
|---|
| 270 | </varlistentry>
|
|---|
| 271 |
|
|---|
| 272 | <varlistentry id="lp-cups">
|
|---|
| 273 | <term><command>lp</command></term>
|
|---|
| 274 | <listitem>
|
|---|
| 275 | <para>submits files for printing or alters a pending job.</para>
|
|---|
| 276 | <indexterm zone="cups lp-cups">
|
|---|
| 277 | <primary sortas="b-lp">lp</primary>
|
|---|
| 278 | </indexterm>
|
|---|
| 279 | </listitem>
|
|---|
| 280 | </varlistentry>
|
|---|
| 281 |
|
|---|
| 282 | <varlistentry id="lpadmin">
|
|---|
| 283 | <term><command>lpadmin</command></term>
|
|---|
| 284 | <listitem>
|
|---|
| 285 | <para>configures printer and class queues provided by
|
|---|
| 286 | <application>CUPS</application>.</para>
|
|---|
| 287 | <indexterm zone="cups lpadmin">
|
|---|
| 288 | <primary sortas="b-lpadmin">lpadmin</primary>
|
|---|
| 289 | </indexterm>
|
|---|
| 290 | </listitem>
|
|---|
| 291 | </varlistentry>
|
|---|
| 292 |
|
|---|
| 293 | <varlistentry id="lpc-cups">
|
|---|
| 294 | <term><command>lpc</command></term>
|
|---|
| 295 | <listitem>
|
|---|
| 296 | <para> provides limited control over printer and class queues
|
|---|
| 297 | provided by <application>CUPS</application>.</para>
|
|---|
| 298 | <indexterm zone="cups lpc-cups">
|
|---|
| 299 | <primary sortas="b-lpc">lpc</primary>
|
|---|
| 300 | </indexterm>
|
|---|
| 301 | </listitem>
|
|---|
| 302 | </varlistentry>
|
|---|
| 303 |
|
|---|
| 304 | <varlistentry id="lpinfo">
|
|---|
| 305 | <term><command>lpinfo</command></term>
|
|---|
| 306 | <listitem>
|
|---|
| 307 | <para>lists the available devices or drivers known to the
|
|---|
| 308 | <application>CUPS</application> server.</para>
|
|---|
| 309 | <indexterm zone="cups lpinfo">
|
|---|
| 310 | <primary sortas="b-lpinfo">lpinfo</primary>
|
|---|
| 311 | </indexterm>
|
|---|
| 312 | </listitem>
|
|---|
| 313 | </varlistentry>
|
|---|
| 314 |
|
|---|
| 315 | <varlistentry id="lpmove">
|
|---|
| 316 | <term><command>lpmove</command></term>
|
|---|
| 317 | <listitem>
|
|---|
| 318 | <para>moves the specified job to a new destination.</para>
|
|---|
| 319 | <indexterm zone="cups lpmove">
|
|---|
| 320 | <primary sortas="b-lpmove">lpmove</primary>
|
|---|
| 321 | </indexterm>
|
|---|
| 322 | </listitem>
|
|---|
| 323 | </varlistentry>
|
|---|
| 324 |
|
|---|
| 325 | <varlistentry id="lpoptions">
|
|---|
| 326 | <term><command>lpoptions</command></term>
|
|---|
| 327 | <listitem>
|
|---|
| 328 | <para>displays or sets printer options and defaults.</para>
|
|---|
| 329 | <indexterm zone="cups lpoptions">
|
|---|
| 330 | <primary sortas="b-lpoptions">lpoptions</primary>
|
|---|
| 331 | </indexterm>
|
|---|
| 332 | </listitem>
|
|---|
| 333 | </varlistentry>
|
|---|
| 334 |
|
|---|
| 335 | <varlistentry id="lppasswd">
|
|---|
| 336 | <term><command>lppasswd</command></term>
|
|---|
| 337 | <listitem>
|
|---|
| 338 | <para>adds, changes or deletes passwords in the
|
|---|
| 339 | <application>CUPS</application> digest password file
|
|---|
| 340 | <filename>passwd.md5</filename>.</para>
|
|---|
| 341 | <indexterm zone="cups lppasswd">
|
|---|
| 342 | <primary sortas="b-lppasswd">lppasswd</primary>
|
|---|
| 343 | </indexterm>
|
|---|
| 344 | </listitem>
|
|---|
| 345 | </varlistentry>
|
|---|
| 346 |
|
|---|
| 347 | <varlistentry id="lpq-cups">
|
|---|
| 348 | <term><command>lpq</command></term>
|
|---|
| 349 | <listitem>
|
|---|
| 350 | <para>shows the current print queue status on the named printer.</para>
|
|---|
| 351 | <indexterm zone="cups lpq-cups">
|
|---|
| 352 | <primary sortas="b-lpq">lpq</primary>
|
|---|
| 353 | </indexterm>
|
|---|
| 354 | </listitem>
|
|---|
| 355 | </varlistentry>
|
|---|
| 356 |
|
|---|
| 357 | <varlistentry id="lpr-cups">
|
|---|
| 358 | <term><command>lpr</command></term>
|
|---|
| 359 | <listitem>
|
|---|
| 360 | <para>submits files for printing.</para>
|
|---|
| 361 | <indexterm zone="cups lpr-cups">
|
|---|
| 362 | <primary sortas="b-lpr">lpr</primary>
|
|---|
| 363 | </indexterm>
|
|---|
| 364 | </listitem>
|
|---|
| 365 | </varlistentry>
|
|---|
| 366 |
|
|---|
| 367 | <varlistentry id="lprm-cups">
|
|---|
| 368 | <term><command>lprm</command></term>
|
|---|
| 369 | <listitem>
|
|---|
| 370 | <para>cancels print jobs that have been queued for printing.</para>
|
|---|
| 371 | <indexterm zone="cups lprm-cups">
|
|---|
| 372 | <primary sortas="b-lprm">lprm</primary>
|
|---|
| 373 | </indexterm>
|
|---|
| 374 | </listitem>
|
|---|
| 375 | </varlistentry>
|
|---|
| 376 |
|
|---|
| 377 | <varlistentry id="lpstat-cups">
|
|---|
| 378 | <term><command>lpstat</command></term>
|
|---|
| 379 | <listitem>
|
|---|
| 380 | <para>displays status information about the current classes, jobs,
|
|---|
| 381 | and printers.</para>
|
|---|
| 382 | <indexterm zone="cups lpstat-cups">
|
|---|
| 383 | <primary sortas="b-lpstat">lpstat</primary>
|
|---|
| 384 | </indexterm>
|
|---|
| 385 | </listitem>
|
|---|
| 386 | </varlistentry>
|
|---|
| 387 |
|
|---|
| 388 | <varlistentry id="reject">
|
|---|
| 389 | <term><command>reject</command></term>
|
|---|
| 390 | <listitem>
|
|---|
| 391 | <para>instructs the printing system to reject print jobs to the
|
|---|
| 392 | specified destinations.</para>
|
|---|
| 393 | <indexterm zone="cups reject">
|
|---|
| 394 | <primary sortas="b-reject">reject</primary>
|
|---|
| 395 | </indexterm>
|
|---|
| 396 | </listitem>
|
|---|
| 397 | </varlistentry>
|
|---|
| 398 |
|
|---|
| 399 | </variablelist>
|
|---|
| 400 |
|
|---|
| 401 | </sect2>
|
|---|
| 402 |
|
|---|
| 403 | </sect1>
|
|---|
