[cd8a01b8] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[73ddd1a0] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[1da819b] | 6 |
|
---|
[1d615c21] | 7 | <!ENTITY cups-download-http "https://github.com/apple/cups/releases/download/v&cups-version;/cups-&cups-version;-source.tar.gz">
|
---|
[5ddee7fb] | 8 | <!ENTITY cups-download-ftp " ">
|
---|
[94a993c5] | 9 | <!ENTITY cups-md5sum "ac703bcde223dab6d205a5fff193f716">
|
---|
| 10 | <!ENTITY cups-size "9.9 MB">
|
---|
| 11 | <!ENTITY cups-buildsize "58 MB">
|
---|
| 12 | <!ENTITY cups-time "0.5 SBU">
|
---|
[73ddd1a0] | 13 | ]>
|
---|
| 14 |
|
---|
[47dc0bf] | 15 | <sect1 id="cups" xreflabel="Cups-&cups-version;">
|
---|
[536fac5] | 16 | <?dbhtml filename="cups.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[47dc0bf] | 23 | <title>Cups-&cups-version;</title>
|
---|
[536fac5] | 24 |
|
---|
| 25 | <indexterm zone="cups">
|
---|
[47dc0bf] | 26 | <primary sortas="a-Cups">Cups</primary>
|
---|
[536fac5] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[47dc0bf] | 30 | <title>Introduction to Cups</title>
|
---|
[536fac5] | 31 |
|
---|
[89475857] | 32 | <para>
|
---|
| 33 | The Common Unix Printing System (CUPS) is a print spooler and
|
---|
| 34 | associated utilities. It is based on the "Internet Printing
|
---|
| 35 | Protocol" and provides printing services to most PostScript
|
---|
| 36 | and raster printers.
|
---|
| 37 | </para>
|
---|
[536fac5] | 38 |
|
---|
[ee85ab4] | 39 | &lfs82_checked;
|
---|
[14d01d8] | 40 |
|
---|
[536fac5] | 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
[89475857] | 44 | <para>
|
---|
| 45 | Download (HTTP): <ulink url="&cups-download-http;"/>
|
---|
| 46 | </para>
|
---|
[536fac5] | 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
[89475857] | 49 | <para>
|
---|
| 50 | Download (FTP): <ulink url="&cups-download-ftp;"/>
|
---|
| 51 | </para>
|
---|
[536fac5] | 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
[89475857] | 54 | <para>
|
---|
| 55 | Download MD5 sum: &cups-md5sum;
|
---|
| 56 | </para>
|
---|
[536fac5] | 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[89475857] | 59 | <para>
|
---|
| 60 | Download size: &cups-size;
|
---|
| 61 | </para>
|
---|
[536fac5] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[89475857] | 64 | <para>
|
---|
| 65 | Estimated disk space required: &cups-buildsize;
|
---|
| 66 | </para>
|
---|
[536fac5] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[89475857] | 69 | <para>
|
---|
| 70 | Estimated build time: &cups-time;
|
---|
| 71 | </para>
|
---|
[536fac5] | 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
[852554e1] | 74 |
|
---|
[47dc0bf] | 75 | <bridgehead renderas="sect3">Cups Dependencies</bridgehead>
|
---|
[536fac5] | 76 |
|
---|
[53debf3] | 77 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 78 | <para role="required">
|
---|
| 79 | <xref linkend="gnutls"/>
|
---|
| 80 | </para>
|
---|
| 81 |
|
---|
[536fac5] | 82 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[14d01d8] | 83 | <para role="recommended">
|
---|
[54666831] | 84 | <xref linkend="colord"/>,
|
---|
[66d9ef8] | 85 | <xref linkend="dbus"/>,
|
---|
[905e8ca] | 86 | <xref linkend="libusb"/>,
|
---|
| 87 | <xref linkend="linux-pam"/>, and
|
---|
[66d9ef8] | 88 | <xref linkend="xdg-utils"/>
|
---|
[14d01d8] | 89 | </para>
|
---|
[536fac5] | 90 |
|
---|
| 91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[bc6e56d] | 92 | <para role="optional">
|
---|
[5e7d3013] | 93 | <xref linkend="avahi"/>,
|
---|
[1ecdb18] | 94 | <xref linkend="libpaper"/>,
|
---|
[89475857] | 95 | <xref linkend="mitkrb"/>,
|
---|
| 96 | <xref linkend="openjdk"/>,
|
---|
[66d9ef8] | 97 | <xref linkend="php"/>, and
|
---|
| 98 | <xref linkend="python2"/>
|
---|
[14d01d8] | 99 | </para>
|
---|
[536fac5] | 100 |
|
---|
[5f83175] | 101 | <bridgehead renderas="sect4">Required (Postinstall)</bridgehead>
|
---|
[1051f94e] | 102 | <para role="required">
|
---|
| 103 | <xref role="runtime" linkend="cups-filters"/>
|
---|
[dcbd2c6] | 104 | </para>
|
---|
| 105 |
|
---|
[5f83175] | 106 | <bridgehead renderas="sect4">Optional (Postinstall)</bridgehead>
|
---|
[1051f94e] | 107 | <para role="optional">
|
---|
| 108 | <xref role="runtime" linkend="gutenprint"/> and
|
---|
| 109 | <ulink role="runtime" url="http://hplipopensource.com/hplip-web/index.html">hplip</ulink> (HP printers)
|
---|
[5f83175] | 110 | </para>
|
---|
[7b88d5a] | 111 |
|
---|
[977061b0] | 112 | <para condition="html" role="usernotes">User Notes:
|
---|
[89475857] | 113 | <ulink url="&blfs-wiki;/cups"/>
|
---|
| 114 | </para>
|
---|
[536fac5] | 115 | </sect2>
|
---|
| 116 |
|
---|
[47dc0bf] | 117 | <sect2 role="kernel" id="cups-kernel">
|
---|
| 118 | <title>Kernel Configuration</title>
|
---|
| 119 |
|
---|
[89475857] | 120 | <note>
|
---|
| 121 | <para>
|
---|
[ae2cb05] | 122 | There used to be a conflict between the <application>Cups</application>
|
---|
[5618cdc] | 123 | <application>libusb</application> backend and the usblp kernel driver.
|
---|
| 124 | This is no longer the case and cups will work with both of these
|
---|
[ae2cb05] | 125 | enabled.
|
---|
[89475857] | 126 | </para>
|
---|
| 127 | </note>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
[ae2cb05] | 130 | If you want to use the kernel usblp driver (for example, if you wish to
|
---|
[5618cdc] | 131 | use <application>escputil</application> from <xref
|
---|
| 132 | linkend="gutenprint"/>) enable the following options in your kernel
|
---|
| 133 | configuration and recompile the kernel:
|
---|
[89475857] | 134 | </para>
|
---|
[47dc0bf] | 135 |
|
---|
[5f83175] | 136 | <screen><literal>Device Drivers --->
|
---|
[38155d1] | 137 | [*] USB support ---> [CONFIG_USB_SUPPORT]
|
---|
| 138 | <*/M> OHCI HCD (USB 1.1) support [CONFIG_USB_OHCI_HCD]
|
---|
| 139 | <*/M> UHCI HCD (most Intel and VIA) support [CONFIG_USB_UHCI_HCD]
|
---|
| 140 | <*/M> USB Printer support [CONFIG_USB_PRINTER]</literal></screen>
|
---|
[47dc0bf] | 141 |
|
---|
[89475857] | 142 | <para>
|
---|
[2946338a] | 143 | If you have a parallel printer, enable the following options in your
|
---|
[89475857] | 144 | kernel configuration and recompile the kernel:
|
---|
| 145 | </para>
|
---|
| 146 |
|
---|
| 147 | <screen><literal>Device Drivers --->
|
---|
[38155d1] | 148 | <*/M> Parallel port support ---> [CONFIG_PARPORT]
|
---|
| 149 | <*/M> PC-style hardware [CONFIG_PARPORT_PC]
|
---|
[89475857] | 150 | Character devices --->
|
---|
[38155d1] | 151 | <*/M> Parallel printer support [CONFIG_PRINTER]</literal></screen>
|
---|
[89475857] | 152 |
|
---|
[47dc0bf] | 153 | <indexterm zone="cups cups-kernel">
|
---|
| 154 | <primary sortas="d-cups">cups</primary>
|
---|
| 155 | </indexterm>
|
---|
| 156 |
|
---|
| 157 | </sect2>
|
---|
| 158 |
|
---|
[536fac5] | 159 | <sect2 role="installation">
|
---|
[47dc0bf] | 160 | <title>Installation of Cups</title>
|
---|
[536fac5] | 161 |
|
---|
[89475857] | 162 | <para>
|
---|
[2946338a] | 163 | You will need to add an <systemitem class="username">lp</systemitem>
|
---|
[89475857] | 164 | user, as <application>Cups</application> will create some files owned
|
---|
| 165 | by this user. (The <systemitem class="username">lp</systemitem> user
|
---|
| 166 | is the default used by <application>Cups</application>, but may be
|
---|
| 167 | changed to a different user by passing a parameter to the
|
---|
| 168 | <command>configure</command> script.) Use the following command as
|
---|
| 169 | the <systemitem class="username">root</systemitem> user:
|
---|
| 170 | </para>
|
---|
| 171 |
|
---|
| 172 | <screen role="root"><userinput>useradd -c "Print Service User" -d /var/spool/cups -g lp -s /bin/false -u 9 lp</userinput></screen>
|
---|
[536fac5] | 173 |
|
---|
[89475857] | 174 | <para>
|
---|
[2946338a] | 175 | You will also need a dedicated group that will contain users allowed to
|
---|
[89475857] | 176 | do <application>Cups</application> administrative tasks. Add the group
|
---|
| 177 | by running the following command as the
|
---|
| 178 | <systemitem class="username">root</systemitem> user:
|
---|
| 179 | </para>
|
---|
[536fac5] | 180 |
|
---|
[89475857] | 181 | <screen role="root"><userinput>groupadd -g 19 lpadmin</userinput></screen>
|
---|
[536fac5] | 182 |
|
---|
[89475857] | 183 | <para>
|
---|
[2946338a] | 184 | If you want to add a user to the <application>Cups</application>
|
---|
[89475857] | 185 | administrative group, run the following command as the
|
---|
| 186 | <systemitem class="username">root</systemitem> user:
|
---|
| 187 | </para>
|
---|
| 188 |
|
---|
| 189 | <screen role="root"><userinput>usermod -a -G lpadmin <replaceable><username></replaceable></userinput></screen>
|
---|
| 190 |
|
---|
| 191 | <para>
|
---|
| 192 | If you didn't install <xref linkend="xdg-utils"/>, use the following
|
---|
| 193 | <command>sed</command> to change the default browser that will be used
|
---|
| 194 | to access the <application>Cups</application> web interface:
|
---|
| 195 | </para>
|
---|
| 196 |
|
---|
| 197 | <screen><userinput>sed -i 's#@CUPS_HTMLVIEW@#firefox#' desktop/cups.desktop.in</userinput></screen>
|
---|
| 198 |
|
---|
| 199 | <para>
|
---|
| 200 | Replace <command>firefox</command> with the web browser of your
|
---|
| 201 | choice.
|
---|
| 202 | </para>
|
---|
[ea48bbe] | 203 |
|
---|
[5618cdc] | 204 | <para>
|
---|
[5f83175] | 205 | Build <application>Cups</application> by running the following commands:
|
---|
[5618cdc] | 206 | </para>
|
---|
| 207 |
|
---|
[b256695] | 208 |
|
---|
[0e6eeb8] | 209 | <screen revision="sysv"><userinput>sed -i 's:444:644:' Makedefs.in &&
|
---|
[5a916f4] | 210 | sed -i '/MAN.EXT/s:.gz::' configure config-scripts/cups-manpages.m4 &&
|
---|
[b88584a] | 211 |
|
---|
[5618cdc] | 212 | aclocal -I config-scripts &&
|
---|
[abc1ddb] | 213 | autoconf -I config-scripts &&
|
---|
[93343b6] | 214 |
|
---|
[f6d40b7d] | 215 | CC=gcc \
|
---|
[5618cdc] | 216 | ./configure --libdir=/usr/lib \
|
---|
| 217 | --disable-systemd \
|
---|
| 218 | --with-rcdir=/tmp/cupsinit \
|
---|
| 219 | --with-system-groups=lpadmin \
|
---|
[2c1a7b7f] | 220 | --with-docdir=/usr/share/cups/doc-&cups-version; &&
|
---|
[536fac5] | 221 | make</userinput></screen>
|
---|
| 222 |
|
---|
[0e6eeb8] | 223 | <screen revision="systemd"><userinput>sed -i 's:555:755:g;s:444:644:g' Makedefs.in &&
|
---|
| 224 | sed -i '/MAN.EXT/s:.gz::g' configure config-scripts/cups-manpages.m4 &&
|
---|
| 225 |
|
---|
[3ace4c5] | 226 | aclocal -I config-scripts &&
|
---|
| 227 | autoconf -I config-scripts &&
|
---|
| 228 |
|
---|
| 229 | CC=gcc \
|
---|
| 230 | ./configure --libdir=/usr/lib \
|
---|
| 231 | --with-rcdir=/tmp/cupsinit \
|
---|
| 232 | --with-system-groups=lpadmin \
|
---|
| 233 | --with-docdir=/usr/share/cups/doc-&cups-version; &&
|
---|
| 234 | make</userinput></screen>
|
---|
| 235 |
|
---|
[a92a3a9] | 236 | <para>
|
---|
[e5e7a1d] | 237 | To test the results, issue: <command>make -k check</command>. An already
|
---|
[a92a3a9] | 238 | active graphical session with bus address is necessary to run the tests.
|
---|
[e5e7a1d] | 239 | Some tests fail for unknown reasons.
|
---|
[a92a3a9] | 240 | </para>
|
---|
[24962f9] | 241 |
|
---|
[89475857] | 242 | <para>
|
---|
[5f83175] | 243 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[89475857] | 244 | </para>
|
---|
[536fac5] | 245 |
|
---|
[2cf3f8a] | 246 | <!-- dev note: make BUILDROOT=<DESTDIR> install -->
|
---|
| 247 |
|
---|
[5c52c23] | 248 | <screen role="root"><userinput>make install &&
|
---|
[89475857] | 249 | rm -rf /tmp/cupsinit &&
|
---|
[2c1a7b7f] | 250 | ln -svnf ../cups/doc-&cups-version; /usr/share/doc/cups-&cups-version;</userinput></screen>
|
---|
[89475857] | 251 |
|
---|
| 252 | <para>
|
---|
[5618cdc] | 253 | Create a basic <application>Cups</application> client configuration file
|
---|
| 254 | by running the following command as the <systemitem
|
---|
| 255 | class="username">root</systemitem> user:
|
---|
[3a55bfe] | 256 | </para>
|
---|
| 257 |
|
---|
| 258 | <screen role="root"><userinput>echo "ServerName /var/run/cups/cups.sock" > /etc/cups/client.conf</userinput></screen>
|
---|
| 259 |
|
---|
[2946338a] | 260 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 261 | href="../../xincludes/gtk-update-icon-cache.xml"/>
|
---|
[6d8f6dc] | 262 |
|
---|
[536fac5] | 263 | </sect2>
|
---|
| 264 |
|
---|
| 265 | <sect2 role="commands">
|
---|
| 266 | <title>Command Explanations</title>
|
---|
| 267 |
|
---|
[5618cdc] | 268 | <para>
|
---|
[2c1a7b7f] | 269 | <command>sed ... Makedefs.in</command>: Fix files and directories
|
---|
| 270 | permissions.
|
---|
[5618cdc] | 271 | </para>
|
---|
| 272 |
|
---|
| 273 | <para>
|
---|
[2c1a7b7f] | 274 | <command>sed ... cups-manpages.m4</command>: This sed prevents
|
---|
| 275 | compression of the man pages by default.
|
---|
[5618cdc] | 276 | </para>
|
---|
| 277 |
|
---|
[93343b6] | 278 | <para>
|
---|
[2c1a7b7f] | 279 | <command>sed ... cups-ssl.m4</command>: Prevent
|
---|
| 280 | <command>configure</command> script from searching
|
---|
| 281 | <command>libgcrypt-config</command>, because
|
---|
| 282 | <application>libgcrypt</application> is not used anywere else in the
|
---|
| 283 | package.
|
---|
[93343b6] | 284 | </para>
|
---|
[f6d40b7d] | 285 |
|
---|
| 286 | <para>
|
---|
| 287 | <envar>CC=gcc</envar>: This environment variable ensures that gcc is used,
|
---|
| 288 | if clang is installed. Remove it, if you prefer to use clang. Using clang
|
---|
| 289 | almost doubles build time and slightly decreases build disk space.
|
---|
| 290 | Installed disk space is not appreciably modified.
|
---|
| 291 | </para>
|
---|
[a090d8b] | 292 |
|
---|
[3ace4c5] | 293 | <para revision="sysv">
|
---|
[5618cdc] | 294 | <parameter>--disable-systemd</parameter>: Systemd is not supported by
|
---|
[66d9ef8] | 295 | this version of BLFS.
|
---|
[5618cdc] | 296 | </para>
|
---|
| 297 |
|
---|
| 298 | <para>
|
---|
| 299 | <parameter>--with-rcdir=/tmp/cupsinit</parameter>: This switch tells the
|
---|
| 300 | build process to install the shipped bootscript into <filename
|
---|
| 301 | class="directory">/tmp</filename> instead of <filename
|
---|
| 302 | class="directory">/etc/rc.d</filename>.
|
---|
[89475857] | 303 | </para>
|
---|
| 304 |
|
---|
| 305 | <para>
|
---|
| 306 | <parameter>--with-system-groups=lpadmin</parameter>: This switch ensures
|
---|
[5618cdc] | 307 | that only <systemitem class="groupname">lpadmin</systemitem> will be used
|
---|
| 308 | as the <application>Cups</application> administrative group.
|
---|
[89475857] | 309 | </para>
|
---|
[47dc0bf] | 310 |
|
---|
[89475857] | 311 | <para>
|
---|
| 312 | <option>--disable-libusb</option>: Use this switch if you have installed
|
---|
| 313 | <xref linkend="libusb"/>, but wish to use the kernel usblp driver.
|
---|
| 314 | </para>
|
---|
[47dc0bf] | 315 |
|
---|
[89475857] | 316 | <para>
|
---|
| 317 | <option>--enable-libpaper</option>: Use this switch if you have installed
|
---|
| 318 | <application>libpaper</application> and wish to use it with
|
---|
| 319 | <application>Cups</application>.
|
---|
| 320 | </para>
|
---|
[47dc0bf] | 321 |
|
---|
[536fac5] | 322 | </sect2>
|
---|
| 323 |
|
---|
| 324 | <sect2 role="configuration">
|
---|
[47dc0bf] | 325 | <title>Configuring Cups</title>
|
---|
[536fac5] | 326 |
|
---|
[2cf3f8a] | 327 | <sect3 id="cups-config">
|
---|
| 328 | <title>Config Files</title>
|
---|
[89475857] | 329 |
|
---|
[2cf3f8a] | 330 | <para><filename>/etc/cups/*</filename></para>
|
---|
| 331 |
|
---|
| 332 | <indexterm zone="cups cups-config">
|
---|
| 333 | <primary sortas="e-etc-cups">/etc/cups/*</primary>
|
---|
| 334 | </indexterm>
|
---|
| 335 |
|
---|
| 336 | </sect3>
|
---|
| 337 |
|
---|
| 338 | <sect3>
|
---|
| 339 | <title>Configuration Information</title>
|
---|
| 340 |
|
---|
[5f83175] | 341 | <para>
|
---|
| 342 | Normally, printers are set up via a web browser. The
|
---|
| 343 | <application>Cups</application> server will normally connect via
|
---|
| 344 | the url http://localhost:631. From there printers, print
|
---|
| 345 | jobs, and the server configuration can be set up and managed.
|
---|
| 346 | Remote system administration can also be set up. Configuration
|
---|
[7b88d5a] | 347 | can also be done from the command line via the
|
---|
| 348 | <command>lpadmin</command>, <command>lpoptions</command>,
|
---|
[5f83175] | 349 | and <command>lpstat</command> commands.
|
---|
| 350 | </para>
|
---|
| 351 |
|
---|
[2cf3f8a] | 352 | <para>
|
---|
| 353 | Configuration of <application>Cups</application> is dependent on
|
---|
| 354 | the type of printer and can be complex. Generally, PostScript printers
|
---|
| 355 | are easier. For detailed instructions on configuration and use of
|
---|
| 356 | <application>Cups</application>, see <ulink
|
---|
[7b88d5a] | 357 | url="http://www.cups.org/documentation.php"/>.
|
---|
[2cf3f8a] | 358 | </para>
|
---|
| 359 |
|
---|
| 360 | <para>
|
---|
| 361 | For non-PostScript printers to print with
|
---|
[5618cdc] | 362 | <application>Cups</application>, you need to install <xref
|
---|
| 363 | linkend="gs"/> to convert PostScript to raster images and a driver
|
---|
[5f83175] | 364 | (e.g. from <xref linkend="gutenprint"/>) to convert the resulting
|
---|
[5618cdc] | 365 | raster images to a form that the printer understands. <ulink
|
---|
| 366 | url="http://www.linuxprinting.org/foomatic.html">Foomatic</ulink>
|
---|
[5f83175] | 367 | drivers use <xref linkend="gs"/> to convert PostScript to a printable
|
---|
| 368 | form directly, but this is considered suboptimal by
|
---|
[5618cdc] | 369 | <application>Cups</application> developers.
|
---|
[2cf3f8a] | 370 | </para>
|
---|
| 371 |
|
---|
| 372 | </sect3>
|
---|
[89475857] | 373 |
|
---|
[2c1a7b7f] | 374 | <sect3>
|
---|
| 375 | <title>Linux PAM Configuration</title>
|
---|
| 376 |
|
---|
| 377 | <para>
|
---|
| 378 | If <application>CUPS</application> has been built with
|
---|
| 379 | <application>Linux PAM</application> support, you need to create a
|
---|
[5f83175] | 380 | <application>PAM</application> configuration file to get it working
|
---|
[2c1a7b7f] | 381 | correctly with BLFS.
|
---|
| 382 | </para>
|
---|
| 383 |
|
---|
| 384 | <para>
|
---|
| 385 | Issue the following command as the <systemitem
|
---|
| 386 | class="username">root</systemitem> user to create the configuration
|
---|
| 387 | file for <application>Linux PAM</application>:
|
---|
| 388 | </para>
|
---|
| 389 |
|
---|
[3503806d] | 390 | <screen role="root"><userinput>cat > /etc/pam.d/cups << "EOF"
|
---|
[2c1a7b7f] | 391 | <literal># Begin /etc/pam.d/cups
|
---|
| 392 |
|
---|
| 393 | auth include system-auth
|
---|
| 394 | account include system-account
|
---|
| 395 | session include system-session
|
---|
| 396 |
|
---|
| 397 | # End /etc/pam.d/cups</literal>
|
---|
| 398 | EOF</userinput></screen>
|
---|
| 399 |
|
---|
| 400 | </sect3>
|
---|
| 401 |
|
---|
[32d0e29] | 402 | <sect3 id="cups-init">
|
---|
[3ace4c5] | 403 | <title><phrase revision="sysv">Boot Script</phrase>
|
---|
| 404 | <phrase revision="systemd">Systemd Unit</phrase></title>
|
---|
[536fac5] | 405 |
|
---|
[3ace4c5] | 406 | <para revision="sysv">
|
---|
[2946338a] | 407 | If you want the <application>Cups</application> print service to start
|
---|
[3ace4c5] | 408 | automatically when the system is booted, install the init script
|
---|
| 409 | included in the <xref linkend="bootscripts"/> package:
|
---|
| 410 | </para>
|
---|
| 411 |
|
---|
[5ebb2cc] | 412 | <para revision="systemd">
|
---|
[3ace4c5] | 413 | To start the <command>cupsd</command> daemon when something tries to
|
---|
| 414 | access it, enable the previously installed systemd units by running
|
---|
| 415 | the following command as the
|
---|
| 416 | <systemitem class="username">root</systemitem> user:
|
---|
[89475857] | 417 | </para>
|
---|
[536fac5] | 418 |
|
---|
| 419 | <indexterm zone="cups cups-init">
|
---|
| 420 | <primary sortas="f-cups">cups</primary>
|
---|
| 421 | </indexterm>
|
---|
| 422 |
|
---|
[3ace4c5] | 423 | <screen role="root" revision="sysv"><userinput>make install-cups</userinput></screen>
|
---|
| 424 |
|
---|
| 425 | <screen role="root" revision="systemd"><userinput>systemctl enable org.cups.cupsd</userinput></screen>
|
---|
[536fac5] | 426 |
|
---|
| 427 | </sect3>
|
---|
| 428 |
|
---|
| 429 | </sect2>
|
---|
| 430 |
|
---|
| 431 | <sect2 role="content">
|
---|
| 432 | <title>Contents</title>
|
---|
| 433 |
|
---|
| 434 | <segmentedlist>
|
---|
| 435 | <segtitle>Installed Programs</segtitle>
|
---|
| 436 | <segtitle>Installed Libraries</segtitle>
|
---|
| 437 | <segtitle>Installed Directories</segtitle>
|
---|
| 438 |
|
---|
| 439 | <seglistitem>
|
---|
[89475857] | 440 | <seg>
|
---|
[5618cdc] | 441 | accept, cancel, cupsaccept, cupsaddsmb, cups-config, cupsctl, cupsd,
|
---|
| 442 | cupsdisable, cupsenable, cupsfilter, cupsreject, cupstestdsc,
|
---|
| 443 | cupstestppd, ippfind, ipptool, lp, lpadmin, lpc, lpinfo, lpmove,
|
---|
| 444 | lpoptions, lpq, lpr, lprm, lpstat, ppdc, ppdhtml, ppdi, ppdmerge,
|
---|
| 445 | ppdpo, and reject
|
---|
[89475857] | 446 | </seg>
|
---|
| 447 | <seg>
|
---|
| 448 | libcupscgi.so, libcupsimage.so, libcupsmime.so,
|
---|
[5618cdc] | 449 | libcupsppdc.so, and libcups.so
|
---|
[89475857] | 450 | </seg>
|
---|
| 451 | <seg>
|
---|
[52e175b] | 452 | /etc/cups,
|
---|
| 453 | /usr/{include,lib,share}/cups,
|
---|
| 454 | /usr/share/doc/cups-&cups-version;, and
|
---|
| 455 | /var/{cache,log,run,spool}/cups
|
---|
[89475857] | 456 | </seg>
|
---|
[536fac5] | 457 | </seglistitem>
|
---|
| 458 | </segmentedlist>
|
---|
| 459 |
|
---|
| 460 | <variablelist>
|
---|
| 461 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 462 | <?dbfo list-presentation="list"?>
|
---|
| 463 | <?dbhtml list-presentation="table"?>
|
---|
| 464 |
|
---|
| 465 | <varlistentry id="accept">
|
---|
| 466 | <term><command>accept</command></term>
|
---|
| 467 | <listitem>
|
---|
[89475857] | 468 | <para>
|
---|
| 469 | instructs the printing system to accept print jobs to the
|
---|
| 470 | specified destinations.
|
---|
| 471 | </para>
|
---|
[536fac5] | 472 | <indexterm zone="cups accept">
|
---|
| 473 | <primary sortas="b-accept">accept</primary>
|
---|
| 474 | </indexterm>
|
---|
| 475 | </listitem>
|
---|
| 476 | </varlistentry>
|
---|
| 477 |
|
---|
| 478 | <varlistentry id="cancel-cups">
|
---|
| 479 | <term><command>cancel</command></term>
|
---|
| 480 | <listitem>
|
---|
[89475857] | 481 | <para>
|
---|
| 482 | cancels existing print jobs from the print queues.
|
---|
| 483 | </para>
|
---|
[536fac5] | 484 | <indexterm zone="cups cancel-cups">
|
---|
| 485 | <primary sortas="b-cancel">cancel</primary>
|
---|
| 486 | </indexterm>
|
---|
| 487 | </listitem>
|
---|
| 488 | </varlistentry>
|
---|
| 489 |
|
---|
[298fee30] | 490 | <varlistentry id="cupsaccept">
|
---|
| 491 | <term><command>cupsaccept</command></term>
|
---|
| 492 | <listitem>
|
---|
| 493 | <para>
|
---|
| 494 | accept jobs sent to a destination.
|
---|
| 495 | </para>
|
---|
| 496 | <indexterm zone="cups cupsaccept">
|
---|
| 497 | <primary sortas="b-cupsaccept">cupsaccept</primary>
|
---|
| 498 | </indexterm>
|
---|
| 499 | </listitem>
|
---|
| 500 | </varlistentry>
|
---|
| 501 |
|
---|
[89475857] | 502 | <varlistentry id="cupsaddsmb">
|
---|
| 503 | <term><command>cupsaddsmb</command></term>
|
---|
| 504 | <listitem>
|
---|
| 505 | <para>
|
---|
| 506 | exports printers to the <application>Samba</application>
|
---|
| 507 | software for use with Windows clients.
|
---|
| 508 | </para>
|
---|
| 509 | <indexterm zone="cups cupsaddsmb">
|
---|
| 510 | <primary sortas="b-cupsaddsmb">cupsaddsmb</primary>
|
---|
| 511 | </indexterm>
|
---|
| 512 | </listitem>
|
---|
| 513 | </varlistentry>
|
---|
| 514 |
|
---|
[2cf3f8a] | 515 | <varlistentry id="cups-config-prog">
|
---|
[536fac5] | 516 | <term><command>cups-config</command></term>
|
---|
| 517 | <listitem>
|
---|
[89475857] | 518 | <para>
|
---|
| 519 | is a <application>Cups</application>
|
---|
| 520 | program configuration utility.
|
---|
| 521 | </para>
|
---|
[2cf3f8a] | 522 | <indexterm zone="cups cups-config-prog">
|
---|
[536fac5] | 523 | <primary sortas="b-cups-config">cups-config</primary>
|
---|
| 524 | </indexterm>
|
---|
| 525 | </listitem>
|
---|
| 526 | </varlistentry>
|
---|
| 527 |
|
---|
[89475857] | 528 | <varlistentry id="cupsctl">
|
---|
| 529 | <term><command>cupsctl</command></term>
|
---|
[536fac5] | 530 | <listitem>
|
---|
[89475857] | 531 | <para>
|
---|
| 532 | updates or queries the cupsd.conf file for a server.
|
---|
| 533 | </para>
|
---|
| 534 | <indexterm zone="cups cupsctl">
|
---|
| 535 | <primary sortas="b-cupsctl">cupsctl</primary>
|
---|
[536fac5] | 536 | </indexterm>
|
---|
| 537 | </listitem>
|
---|
| 538 | </varlistentry>
|
---|
| 539 |
|
---|
| 540 | <varlistentry id="cupsd">
|
---|
| 541 | <term><command>cupsd</command></term>
|
---|
| 542 | <listitem>
|
---|
[89475857] | 543 | <para>
|
---|
| 544 | is the scheduler for the Common Unix Printing System.
|
---|
| 545 | </para>
|
---|
[536fac5] | 546 | <indexterm zone="cups cupsd">
|
---|
| 547 | <primary sortas="b-cupsd">cupsd</primary>
|
---|
| 548 | </indexterm>
|
---|
| 549 | </listitem>
|
---|
| 550 | </varlistentry>
|
---|
| 551 |
|
---|
[298fee30] | 552 | <varlistentry id="cupsdisable">
|
---|
| 553 | <term><command>cupsdisable</command></term>
|
---|
| 554 | <listitem>
|
---|
| 555 | <para>
|
---|
| 556 | stop printers and classes.
|
---|
| 557 | </para>
|
---|
| 558 | <indexterm zone="cups cupsdisable">
|
---|
| 559 | <primary sortas="b-cupsdisable">cupsdisable</primary>
|
---|
| 560 | </indexterm>
|
---|
| 561 | </listitem>
|
---|
| 562 | </varlistentry>
|
---|
| 563 |
|
---|
| 564 | <varlistentry id="cupsenable">
|
---|
| 565 | <term><command>cupsenable</command></term>
|
---|
| 566 | <listitem>
|
---|
| 567 | <para>
|
---|
| 568 | start printers and classes.
|
---|
| 569 | </para>
|
---|
| 570 | <indexterm zone="cups cupsenable">
|
---|
| 571 | <primary sortas="b-cupsenable">cupsenable</primary>
|
---|
| 572 | </indexterm>
|
---|
| 573 | </listitem>
|
---|
| 574 | </varlistentry>
|
---|
| 575 |
|
---|
[89475857] | 576 | <varlistentry id="cupsfilter">
|
---|
| 577 | <term><command>cupsfilter</command></term>
|
---|
[536fac5] | 578 | <listitem>
|
---|
[89475857] | 579 | <para>
|
---|
[0d7900a] | 580 | is a front-end to the <application>Cups</application>
|
---|
[89475857] | 581 | filter subsystem which allows you to convert a file
|
---|
| 582 | to a specific format.
|
---|
| 583 | </para>
|
---|
| 584 | <indexterm zone="cups cupsfilter">
|
---|
| 585 | <primary sortas="b-cupsfilter">cupsfilter</primary>
|
---|
[536fac5] | 586 | </indexterm>
|
---|
| 587 | </listitem>
|
---|
| 588 | </varlistentry>
|
---|
| 589 |
|
---|
[298fee30] | 590 | <varlistentry id="cupsreject">
|
---|
| 591 | <term><command>cupsreject</command></term>
|
---|
| 592 | <listitem>
|
---|
| 593 | <para>
|
---|
| 594 | reject jobs sent to a destination.
|
---|
| 595 | </para>
|
---|
| 596 | <indexterm zone="cups cupsreject">
|
---|
| 597 | <primary sortas="b-cupsreject">cupsreject</primary>
|
---|
| 598 | </indexterm>
|
---|
| 599 | </listitem>
|
---|
| 600 | </varlistentry>
|
---|
| 601 |
|
---|
[89475857] | 602 | <varlistentry id="cupstestdsc">
|
---|
| 603 | <term><command>cupstestdsc</command></term>
|
---|
[536fac5] | 604 | <listitem>
|
---|
[89475857] | 605 | <para>
|
---|
| 606 | tests the conformance of PostScript files.
|
---|
| 607 | </para>
|
---|
| 608 | <indexterm zone="cups cupstestdsc">
|
---|
| 609 | <primary sortas="b-cupstestdsc">cupstestdsc</primary>
|
---|
| 610 | </indexterm>
|
---|
| 611 | </listitem>
|
---|
| 612 | </varlistentry>
|
---|
| 613 |
|
---|
| 614 | <varlistentry id="cupstestppd">
|
---|
| 615 | <term><command>cupstestppd</command></term>
|
---|
| 616 | <listitem>
|
---|
| 617 | <para>
|
---|
| 618 | tests the conformance of PPD files.
|
---|
| 619 | </para>
|
---|
| 620 | <indexterm zone="cups cupstestppd">
|
---|
| 621 | <primary sortas="b-cupstestppd">cupstestppd</primary>
|
---|
[536fac5] | 622 | </indexterm>
|
---|
| 623 | </listitem>
|
---|
| 624 | </varlistentry>
|
---|
| 625 |
|
---|
[95a4ee3] | 626 | <varlistentry id="ippfind">
|
---|
| 627 | <term><command>ippfind</command></term>
|
---|
| 628 | <listitem>
|
---|
| 629 | <para>
|
---|
| 630 | finds internet printing protocol printers.
|
---|
| 631 | </para>
|
---|
| 632 | <indexterm zone="cups ippfind">
|
---|
| 633 | <primary sortas="b-ippfind">ippfind</primary>
|
---|
| 634 | </indexterm>
|
---|
| 635 | </listitem>
|
---|
| 636 | </varlistentry>
|
---|
| 637 |
|
---|
[89475857] | 638 | <varlistentry id="ipptool">
|
---|
| 639 | <term><command>ipptool</command></term>
|
---|
[536fac5] | 640 | <listitem>
|
---|
[89475857] | 641 | <para>
|
---|
| 642 | sends IPP requests to the specified URI and tests
|
---|
| 643 | and/or displays the results.
|
---|
| 644 | </para>
|
---|
| 645 | <indexterm zone="cups ipptool">
|
---|
| 646 | <primary sortas="b-ipptool">ipptool</primary>
|
---|
[536fac5] | 647 | </indexterm>
|
---|
| 648 | </listitem>
|
---|
| 649 | </varlistentry>
|
---|
| 650 |
|
---|
| 651 | <varlistentry id="lp-cups">
|
---|
| 652 | <term><command>lp</command></term>
|
---|
| 653 | <listitem>
|
---|
[89475857] | 654 | <para>
|
---|
| 655 | submits files for printing or alters a pending job.
|
---|
| 656 | </para>
|
---|
[536fac5] | 657 | <indexterm zone="cups lp-cups">
|
---|
| 658 | <primary sortas="b-lp">lp</primary>
|
---|
| 659 | </indexterm>
|
---|
| 660 | </listitem>
|
---|
| 661 | </varlistentry>
|
---|
| 662 |
|
---|
| 663 | <varlistentry id="lpadmin">
|
---|
| 664 | <term><command>lpadmin</command></term>
|
---|
| 665 | <listitem>
|
---|
[89475857] | 666 | <para>
|
---|
| 667 | configures printer and class queues provided by
|
---|
| 668 | <application>Cups</application>.
|
---|
| 669 | </para>
|
---|
[536fac5] | 670 | <indexterm zone="cups lpadmin">
|
---|
| 671 | <primary sortas="b-lpadmin">lpadmin</primary>
|
---|
| 672 | </indexterm>
|
---|
| 673 | </listitem>
|
---|
| 674 | </varlistentry>
|
---|
| 675 |
|
---|
| 676 | <varlistentry id="lpc-cups">
|
---|
| 677 | <term><command>lpc</command></term>
|
---|
| 678 | <listitem>
|
---|
[89475857] | 679 | <para>
|
---|
| 680 | provides limited control over printer and class queues
|
---|
| 681 | provided by <application>Cups</application>.
|
---|
| 682 | </para>
|
---|
[536fac5] | 683 | <indexterm zone="cups lpc-cups">
|
---|
| 684 | <primary sortas="b-lpc">lpc</primary>
|
---|
| 685 | </indexterm>
|
---|
| 686 | </listitem>
|
---|
| 687 | </varlistentry>
|
---|
| 688 |
|
---|
| 689 | <varlistentry id="lpinfo">
|
---|
| 690 | <term><command>lpinfo</command></term>
|
---|
| 691 | <listitem>
|
---|
[89475857] | 692 | <para>
|
---|
| 693 | lists the available devices or drivers known to the
|
---|
| 694 | <application>Cups</application> server.
|
---|
| 695 | </para>
|
---|
[536fac5] | 696 | <indexterm zone="cups lpinfo">
|
---|
| 697 | <primary sortas="b-lpinfo">lpinfo</primary>
|
---|
| 698 | </indexterm>
|
---|
| 699 | </listitem>
|
---|
| 700 | </varlistentry>
|
---|
| 701 |
|
---|
| 702 | <varlistentry id="lpmove">
|
---|
| 703 | <term><command>lpmove</command></term>
|
---|
| 704 | <listitem>
|
---|
[89475857] | 705 | <para>
|
---|
| 706 | moves the specified job to a new destination.
|
---|
| 707 | </para>
|
---|
[536fac5] | 708 | <indexterm zone="cups lpmove">
|
---|
| 709 | <primary sortas="b-lpmove">lpmove</primary>
|
---|
| 710 | </indexterm>
|
---|
| 711 | </listitem>
|
---|
| 712 | </varlistentry>
|
---|
| 713 |
|
---|
| 714 | <varlistentry id="lpoptions">
|
---|
| 715 | <term><command>lpoptions</command></term>
|
---|
| 716 | <listitem>
|
---|
[89475857] | 717 | <para>
|
---|
| 718 | displays or sets printer options and defaults.
|
---|
| 719 | </para>
|
---|
[536fac5] | 720 | <indexterm zone="cups lpoptions">
|
---|
| 721 | <primary sortas="b-lpoptions">lpoptions</primary>
|
---|
| 722 | </indexterm>
|
---|
| 723 | </listitem>
|
---|
| 724 | </varlistentry>
|
---|
| 725 |
|
---|
| 726 | <varlistentry id="lpq-cups">
|
---|
| 727 | <term><command>lpq</command></term>
|
---|
| 728 | <listitem>
|
---|
[89475857] | 729 | <para>
|
---|
| 730 | shows the current print queue status on the named printer.
|
---|
| 731 | </para>
|
---|
[536fac5] | 732 | <indexterm zone="cups lpq-cups">
|
---|
| 733 | <primary sortas="b-lpq">lpq</primary>
|
---|
| 734 | </indexterm>
|
---|
| 735 | </listitem>
|
---|
| 736 | </varlistentry>
|
---|
| 737 |
|
---|
| 738 | <varlistentry id="lpr-cups">
|
---|
| 739 | <term><command>lpr</command></term>
|
---|
| 740 | <listitem>
|
---|
[89475857] | 741 | <para>
|
---|
| 742 | submits files for printing.
|
---|
| 743 | </para>
|
---|
[536fac5] | 744 | <indexterm zone="cups lpr-cups">
|
---|
| 745 | <primary sortas="b-lpr">lpr</primary>
|
---|
| 746 | </indexterm>
|
---|
| 747 | </listitem>
|
---|
| 748 | </varlistentry>
|
---|
| 749 |
|
---|
| 750 | <varlistentry id="lprm-cups">
|
---|
| 751 | <term><command>lprm</command></term>
|
---|
| 752 | <listitem>
|
---|
[89475857] | 753 | <para>
|
---|
| 754 | cancels print jobs that have been queued for printing.
|
---|
| 755 | </para>
|
---|
[536fac5] | 756 | <indexterm zone="cups lprm-cups">
|
---|
| 757 | <primary sortas="b-lprm">lprm</primary>
|
---|
| 758 | </indexterm>
|
---|
| 759 | </listitem>
|
---|
| 760 | </varlistentry>
|
---|
| 761 |
|
---|
| 762 | <varlistentry id="lpstat-cups">
|
---|
| 763 | <term><command>lpstat</command></term>
|
---|
| 764 | <listitem>
|
---|
[89475857] | 765 | <para>
|
---|
| 766 | displays status information about the current classes, jobs,
|
---|
| 767 | and printers.
|
---|
| 768 | </para>
|
---|
[536fac5] | 769 | <indexterm zone="cups lpstat-cups">
|
---|
| 770 | <primary sortas="b-lpstat">lpstat</primary>
|
---|
| 771 | </indexterm>
|
---|
| 772 | </listitem>
|
---|
| 773 | </varlistentry>
|
---|
| 774 |
|
---|
[89475857] | 775 | <varlistentry id="ppdc">
|
---|
| 776 | <term><command>ppdc</command></term>
|
---|
| 777 | <listitem>
|
---|
| 778 | <para>
|
---|
| 779 | compiles PPDC source files into one or more PPD files.
|
---|
| 780 | </para>
|
---|
| 781 | <indexterm zone="cups ppdc">
|
---|
| 782 | <primary sortas="b-ppdc">ppdc</primary>
|
---|
| 783 | </indexterm>
|
---|
| 784 | </listitem>
|
---|
| 785 | </varlistentry>
|
---|
| 786 |
|
---|
| 787 | <varlistentry id="ppdhtml">
|
---|
| 788 | <term><command>ppdhtml</command></term>
|
---|
| 789 | <listitem>
|
---|
| 790 | <para>
|
---|
| 791 | reads a driver information file and produces a HTML summary
|
---|
| 792 | page that lists all of the drivers in a file and the
|
---|
| 793 | supported options.
|
---|
| 794 | </para>
|
---|
| 795 | <indexterm zone="cups ppdhtml">
|
---|
| 796 | <primary sortas="b-ppdhtml">ppdhtml</primary>
|
---|
| 797 | </indexterm>
|
---|
| 798 | </listitem>
|
---|
| 799 | </varlistentry>
|
---|
| 800 |
|
---|
| 801 | <varlistentry id="ppdi">
|
---|
| 802 | <term><command>ppdi</command></term>
|
---|
| 803 | <listitem>
|
---|
| 804 | <para>
|
---|
| 805 | imports one or more PPD files into a PPD compiler source file.
|
---|
| 806 | </para>
|
---|
| 807 | <indexterm zone="cups ppdi">
|
---|
| 808 | <primary sortas="b-ppdi">ppdi</primary>
|
---|
| 809 | </indexterm>
|
---|
| 810 | </listitem>
|
---|
| 811 | </varlistentry>
|
---|
| 812 |
|
---|
| 813 | <varlistentry id="ppdmerge">
|
---|
| 814 | <term><command>ppdmerge</command></term>
|
---|
| 815 | <listitem>
|
---|
| 816 | <para>
|
---|
| 817 | merges two or more PPD files into a single, multi-language
|
---|
| 818 | PPD file.
|
---|
| 819 | </para>
|
---|
| 820 | <indexterm zone="cups ppdmerge">
|
---|
| 821 | <primary sortas="b-ppdmerge">ppdmerge</primary>
|
---|
| 822 | </indexterm>
|
---|
| 823 | </listitem>
|
---|
| 824 | </varlistentry>
|
---|
| 825 |
|
---|
| 826 | <varlistentry id="ppdpo">
|
---|
| 827 | <term><command>ppdpo</command></term>
|
---|
| 828 | <listitem>
|
---|
| 829 | <para>
|
---|
| 830 | extracts UI strings from PPDC source files and
|
---|
| 831 | updates either a GNU gettext or Mac OS X strings
|
---|
| 832 | format message catalog source file for translation.
|
---|
| 833 | </para>
|
---|
| 834 | <indexterm zone="cups ppdpo">
|
---|
| 835 | <primary sortas="b-ppdpo">ppdpo</primary>
|
---|
| 836 | </indexterm>
|
---|
| 837 | </listitem>
|
---|
| 838 | </varlistentry>
|
---|
| 839 |
|
---|
[536fac5] | 840 | <varlistentry id="reject">
|
---|
| 841 | <term><command>reject</command></term>
|
---|
| 842 | <listitem>
|
---|
[89475857] | 843 | <para>
|
---|
| 844 | instructs the printing system to reject print jobs to the
|
---|
| 845 | specified destinations.
|
---|
| 846 | </para>
|
---|
[536fac5] | 847 | <indexterm zone="cups reject">
|
---|
| 848 | <primary sortas="b-reject">reject</primary>
|
---|
| 849 | </indexterm>
|
---|
| 850 | </listitem>
|
---|
| 851 | </varlistentry>
|
---|
| 852 |
|
---|
[89475857] | 853 | <varlistentry id="libcups">
|
---|
| 854 | <term><filename class="libraryfile">libcups.so</filename></term>
|
---|
| 855 | <listitem>
|
---|
| 856 | <para>
|
---|
| 857 | contains the <application>Cups</application> API functions.
|
---|
| 858 | </para>
|
---|
| 859 | <indexterm zone="cups libcups">
|
---|
| 860 | <primary sortas="c-libcups">libcups.so</primary>
|
---|
| 861 | </indexterm>
|
---|
| 862 | </listitem>
|
---|
| 863 | </varlistentry>
|
---|
| 864 |
|
---|
[536fac5] | 865 | </variablelist>
|
---|
| 866 |
|
---|
| 867 | </sect2>
|
---|
[c78533e] | 868 |
|
---|
| 869 | </sect1>
|
---|