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