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