Difference between revisions of "CUPS"

From ArchWiki
Jump to navigation Jump to search
(Auto-loading)
(CLI tools: template:note comments about using the full path. Further commenting it can be used with the {{ic|-P}} command line switch. See {{man|8|lpadmin}}.)
 
(687 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
 
[[Category:Printers]]
 
[[Category:Printers]]
 +
[[Category:Servers]]
 
[[cs:CUPS]]
 
[[cs:CUPS]]
 +
[[de:CUPS]]
 
[[es:CUPS]]
 
[[es:CUPS]]
 +
[[fr:CUPS]]
 
[[it:CUPS]]
 
[[it:CUPS]]
 +
[[ja:CUPS]]
 
[[pl:CUPS]]
 
[[pl:CUPS]]
 
[[ru:CUPS]]
 
[[ru:CUPS]]
 
[[th:CUPS]]
 
[[th:CUPS]]
[[tr:CUPS]]
+
[[zh-hans:CUPS]]
[[zh-CN:CUPS]]
+
[[zh-hant:CUPS]]
[[zh-TW:CUPS]]
+
{{Related articles start}}
{{Article summary start|Summary}}
+
{{Related|CUPS/Printer sharing}}
{{Article summary text|Installing and configuring CUPS}}
+
{{Related|CUPS/Printer-specific problems}}
{{Article summary heading|Related}}
+
{{Related|CUPS/Troubleshooting}}
{{Article summary wiki|CUPS printer sharing}}
+
{{Related|Samba}}
{{Article summary wiki|CUPS printer-specific problems}}
+
{{Related|LPRng}}
{{Article summary wiki|Samba}}
+
{{Related articles end}}
{{Article summary end}}
 
  
From [http://www.cups.org/index.php CUPS' site]:
+
[https://www.cups.org/ CUPS] is the standards-based, open source printing system developed by Apple Inc. for macOS® and other UNIX®-like operating systems.
:"''[[Wikipedia:CUPS|CUPS]] is the standards-based, open source printing system developed by Apple Inc. for Mac OS® X and other UNIX®-like operating systems''".
 
  
Although there are other printing packages such as LPRNG, the Common Unix Printing System is the most popular choice because of its relative ease of use.
+
== Installation ==
  
==Cups Linux Printing workflow==
+
[[Install]] the {{Pkg|cups}} package.
As of version {{Pkg|cups}} 1.5.3-3 ArchLinux makes use of the new full pdf-based printing workflow. For
 
further reading check [http://www.linuxfoundation.org/collaborate/workgroups/openprinting/pdfasstandardprintjobformat PDF standard printing job format] and an old [https://wiki.linuxfoundation.org/en/OpenPrinting/Database/CUPS-Filter-Chart Cups filtering chart] for history and fun.
 
A good starting point for general Linux printing questions is [http://www.linuxfoundation.org/collaborate/workgroups/openprinting here].
 
  
 +
If you intend to "print" into a PDF document, also install the {{pkg|cups-pdf}} package. By default, pdf files are stored in {{ic|/var/spool/cups-pdf/''username''/}}. The location can be changed in {{ic|/etc/cups/cups-pdf.conf}}.
  
There are two ways to setup a printer:
+
[[Enable]] and [[start]] {{ic|org.cups.cupsd.service}}.
* If there's a linux cups server running in your network and sharing a printer you only need to install the client package.
 
* The printer is connected directly to your system or you have access to an IPP network printer then setup a local cups server
 
  
==Installing the client package==
+
=== Socket activation ===
  
===the recommended simple setup===
+
{{Pkg|cups}} provides a {{ic|org.cups.cupsd.socket}} unit. If {{ic|org.cups.cupsd.socket}} is [[enable]]d (and {{ic|org.cups.cupsd.service}} is [[disable]]d), systemd will not start CUPS immediately, it will just listen to the appropriate sockets. Then, whenever a program attempts to connect to one of these CUPS sockets, systemd will start {{ic|org.cups.cupsd.service}} and transparently hand over control of these ports to the CUPS process.
* '''libcups''' is the only package you need to [[pacman|Install]]
 
Then add your cups server IP or hostname into /etc/cups/client.conf. That's all you need. Every application should quickly
 
find the printer(s) shared by that cups server.
 
  
===optional advanced network setup===
+
This way, CUPS is only started once a program wants to make use of the service.
* You can run a cupsd instance on your client with avahi browsing enabled to discover unknown shared printers in your network. This is not recommended in simple home network setups where you usually know your printer server IP or hostname! This makes only sense in large setups where the server is unknown.
 
{{Note| This behavior has not been changed with cups 1.6.x - the difference is that until 1.5.x cupsd was able to do printer browsing alone and now needs avahi to discover unknown printers!}}
 
  
==Installing the server packages==
+
== Connection Interfaces ==
The packages {{Pkg|cups}}, {{Pkg|cups-filters}}, {{Pkg|ghostscript}}, {{Pkg|gsfonts}} and some printer driver are needed. [[pacman|Install]] them from the [[Official repositories]].
 
  
* '''cups''' - The actual CUPS software(daemon)
+
Additional steps for printer detection are listed below for various connection interfaces.
* '''avahi''' - to make your printers browsable through your network
 
* '''cups-filters''' - essential filter pkg
 
* '''ghostscript''' - (optional) Interpreter for the Postscript language
 
* '''gsfonts''' - GhostScript standard Type1 fonts
 
* '''hpoj''' - If you are using an HP Officejet, you should also install this package and follow the instructions to avoid problems. Read this [http://answers.launchpad.net/hplip/+question/133425 thread at launchpad/hplip] for more information.
 
  
If the system is connected to a networked printer using the [[Samba]] protocol or if the system is to be a print server for Windows clients, also install {{Pkg|samba}}.
+
{{Note|1=<nowiki></nowiki>
 +
* CUPS helper programs are run using the {{ic|cups}} user and group. This allows the helper programs to access printer devices and read config files in {{ic|/etc/cups/}}, which are owned by the {{ic|cups}} group.
 +
* Prior to {{Pkg|cups}} 2.2.6-2, the {{ic|lp}} group [https://git.archlinux.org/svntogit/packages.git/commit/trunk?h=packages/cups&id=a209bf21797a239c7ddb4614f0266ba1e5238622 was used instead]. After the upgrade, the files in {{ic|/etc/cups}} should be owned by the {{ic|cups}} group and {{ic|User 209}} and {{ic|Group 209}} set in {{ic|/etc/cups/cups-files.conf}}.
 +
}}
  
Note: As of cups version 1.6 the avahi-daemon should be runnig before cupsd is started if you want to enable printer browsing through your network. Your rc.conf daemon line should look like: "...dbus...avahi-daemon cupsd...". However you don't need to run avahi on your client system if you know the server IP or network name. See client configuration above.
+
=== USB ===
  
===Printer driver===
+
To see if your USB printer is detected:
Here are some of the driver packages. Choosing the right driver depends on the printer:
 
  
* '''{{Pkg|gutenprint}}''' - A collection of high quality drivers for Canon, Epson, Lexmark, Sony, Olympus, and PCL printers for use with GhostSscript, CUPS, Foomatic, and the [[GIMP]]
+
{{hc|$ lsusb|
* '''{{Pkg|foomatic-db}}, {{Pkg|foomatic-db-engine}}, {{Pkg|foomatic-db-nonfree}}, and {{Pkg|foomatic-filters}}''' - Foomatic is a database-driven system for integrating free software printer drivers with common spoolers under Unix. Installing foomatic-filters should solve problems if the cups error_log is reporting "stopped with status 22!".
+
(...)
* '''{{AUR|foo2zjs}}''' - Drivers for ZjStream protocol printers such as the HP Laserjet 1018. More info [http://foo2zjs.rkkda.com here], Foo2zsj is available in the {{AUR|foo2zjs}}.
+
Bus 001 Device 007: ID 03f0:1004 Hewlett-Packard DeskJet 970c/970cse
* '''{{Pkg|hplip}}''' - HP GNU/Linux driver. Provides support for DeskJet, OfficeJet, Photosmart, Business Inkjet and some LaserJet printer models, as well as a number of Brother printers.
+
}}
* '''{{Pkg|splix}}''' - Samsung drivers for SPL (Samsung Printer Language) printers
 
* '''{{AUR|samsung-unified-driver}}''' - Unified Linux Driver for Samsung printers and scanners. Required for new printers, like ML-2160. Package is available in the [[AUR]].
 
* '''{{AUR|ufr2}}''' or '''{{AUR|cndrvcups-lb}}''' - Canon UFR2 driver with support for LBP, iR and MF series printers. Package is available in the [[AUR]].
 
* '''{{Pkg|cups-pdf}}''' - A package that allows one to setup a virtual PDF Printer that generates a PDF out of jobs sent to it
 
  
If unsure of what driver package to install or if the current driver is not working, it may be easiest to just install all of drivers, since some of the packages are misleading because printers of other makes may rely on them. For instance, the Brother HL-2140 needs the hplip driver installed.
+
=== Parallel port ===
  
====Download printer PPD====
+
To use a parallel port printer, the {{ic|lp}}, {{ic|parport}} and {{ic|parport_pc}} [[kernel modules]] are required.
Depending on the printer, this step is optional and may not be needed, as the standard CUPS installation already comes with quite a few PPD (Postscript Printer Description) files. Moreover, the ''foomatic-filters'', ''gimp-print'' and ''hplip'' packages already include quite a few PPD files which will automatically be detected by CUPS.
 
  
Here is an explanation of what a PPD file is from the Linux Printing website:
+
{{hc|$ dmesg {{!}} grep -i parport|
:"''For every PostScript printer the manufacturers provide a PPD file which contains all printer-specific information about the particular printer model: Basic printer capabilities as whether the printer is a color printer, fonts, PostScript level, etc., and especially the user-adjustable options, as paper size, resolution, etc.''"
+
parport0: Printer, Hewlett-Packard HP LaserJet 2100 Series
 
+
lp0: using parport0 (polling)
If the PPD for the printer is ''not'' already in CUPS, then:
+
}}
*check [[AUR]] to see if there are packages for the printer/manufacturer
 
*visit the [http://www.openprinting.org/printers OpenPrinting database] and select the manufacturer and model of the printer
 
*visit the manufacturer's site and search for GNU/Linux drivers
 
  
{{Note|PPD files go in {{ic|/usr/share/cups/model/}}}}
+
=== Network ===
  
==Configuring==
+
To discover or share printers using DNS-SD/mDNS, setup [[Avahi#Hostname_resolution|.local hostname resolution]] with [[Avahi]] and [[restart]] {{ic|org.cups.cupsd.service}}.
Now that CUPS is installed, there are a variety of options on how to setup printing solutions. As always, the tried and true command line method is at your disposal. Likewise, various desktop environments such as GNOME and KDE have useful programs that can help manage printers. However, in order to make this process easy for the largest amount of users, this article will focus on the web interface provided by CUPS.
 
  
If you are planning on connecting to a network printer, rather than one that is directly connected to the computer, you might want to read the [[CUPS printer sharing]] page first. Printer sharing between GNU/Linux systems is quite easy and involves very little configuration, whereas sharing between a Windows and GNU/Linux host requires a little bit more effort.
+
{{Note|DNS-SD is only supported when using [[Avahi]]. CUPS does not support using [[systemd-resolved]] for DNS-SD, see [https://github.com/apple/cups/issues/5452 CUPS issue 5452].}}
  
USB printers can get accessed with two methods: The usblp kernel module and libusb. The former is the classic way. It is simple: Data is sent to the printer by writing it to a device file as a simple serial data stream. Reading the same device file allows bi-di access, at least for things like reading out ink levels, status, or printer capability information (PJL). It works very well for simple printers, but for multi-function devices (printer/scanner) it is not suitable and manufacturers like HP supply their own backends. (source: [http://lists.linuxfoundation.org/pipermail/printing-architecture/2012/002412.html here])
+
To share printers with [[Samba]], e.g. if the system is to be a print server for Windows clients, the {{Pkg|samba}} package will be required.
  
===Kernel modules===
+
== Printer Drivers ==
Before using the CUPS web interface, the appropriate kernel modules need to be installed. The following steps are from the Gentoo Printing Guide.
 
  
This section may not be necessary, however, depending on which kernel is being used. The kernel module may load automatically after plugging in the printer. Use the {{ic|tail}} command (described below) to see if the printer has already been detected. The {{ic|lsmod}} utility can also be used to see what modules have been loaded.
+
{{Expansion|CUPS 2.3 will drop PPD and driver support ([https://github.com/apple/cups/issues/5271 CUPS issue 5271]), instead relying entirely on IPP Everywhere. Explain what is/will be handled by {{Pkg|cups}} and what by {{Pkg|cups-filters}} and/or other software.}}
  
====USB printers====
 
'''As of Cups version 1.6.0 it's typically no more needed to blacklist the usblp kernel module!''' If you find out this is the only way to fix a remaining issue please report this upstream to the cups tracker and maybe also get in contact with Till Kamppeter (Debian cups maintainer). See [http://cups.org/str.php?L4128 upstream bug] for more.
 
  
Some USB printer users may want to try if blacklisting the {{ic|usblp}} module would help:
+
The drivers for a printer may come from any of the sources shown below. See [[CUPS/Printer-specific problems]] for an incomplete list of drivers that others have managed to get working.
  
{{hc|/etc/modprobe.d/blacklist.conf|blacklist usblp}}
+
To drive a printer, CUPS needs a PPD file and, for most printers, some [https://www.cups.org/doc/man-filter.html filters].
 +
For details on how CUPS uses PPDs and filters, see [https://www.cups.org/doc/postscript-driver.html].
  
Custom kernel users may need to manually load the {{ic|usbcore}} module before proceeding:
+
The [http://www.openprinting.org/printers OpenPrinting Printer List] provides driver recommendations for many printers. It also supplies PPD files for each printer, but most are available through [[#Foomatic|foomatic]] or the recommended driver package.
# modprobe usbcore
 
  
Once the modules are installed, plug in the printer and check if the kernel detected it by running the following:
+
When a PPD file is provided to CUPS, the CUPS server will regenerate the PPD files and save them in {{ic|/etc/cups/ppd/}}.
# tail /var/log/messages.log
 
or
 
# dmesg
 
  
If you're using {{ic|usblp}}, the output should indicate that the printer has been detected like so:
+
=== CUPS ===
Feb 19 20:17:11 kernel: printer.c: usblp0: USB Bidirectional
 
printer dev 2 if 0 alt 0 proto 2 vid 0x04E8 pid 0x300E
 
Feb 19 20:17:11 kernel: usb.c: usblp driver claimed interface cfef3920
 
Feb 19 20:17:11 kernel: printer.c: v0.13: USB Printer Device Class driver
 
  
If you blacklisted {{ic|usblp}}, you will see something like:
+
CUPS includes support for [[wikipedia:AirPrint|AirPrint]] and [http://www.pwg.org/ipp/everywhere.html IPP Everywhere] printers.
usb 3-2: new full speed USB device using uhci_hcd and address 3
 
usb 3-2: configuration #1 chosen from 1 choice
 
  
====Parallel port printers====
+
=== OpenPrinting CUPS filters ===
To use a parallel port printer the configuration is pretty much the same, except for the modules:
 
# modprobe lp
 
# modprobe parport
 
# modprobe parport_pc
 
  
Once again, check the setup by running:
+
The Linux Foundation's OpenPrinting workgroup provides [https://wiki.linuxfoundation.org/openprinting/cups-filters cups-filters]. Those are backends, filters, and other binaries that were once part of CUPS but are no longer maintained by Apple. They are available in the {{Pkg|cups-filters}} package that is a dependency of {{Pkg|cups}}.
# tail /var/log/messages.log
 
It should display something like this:
 
lp0: using parport0 (polling).
 
  
If you are using a USB to parallel port adapter, CUPS will not be able to detect the printer. As a workaround, add the printer using a different connection type and then change DeviceID in /etc/cups/printers.conf:
+
Non-PDF printers require {{pkg|ghostscript}} to be installed. For PostScript printers {{Pkg|gsfonts}} may also be required.
DeviceID = parallel:/dev/usb/lp0
 
  
====Auto-loading====
+
=== Foomatic ===
It is convenient to have the system automatically load the kernel module every time it starts up. To do so, use a text editor to open up {{ic|/etc/modules-load.d/[[printing.conf]]}} and add the appropriate modules one per line. Here is an example:
 
lp
 
parport
 
parport_pc
 
  
===CUPS daemon===
+
The Linux Foundation's OpenPrinting workgroup's [https://wiki.linuxfoundation.org/openprinting/database/foomatic foomatic] provides PPDs for many printer drivers, both free and nonfree. For more information about what foomatic does, see [http://www.openprinting.org/download/kpfeifle/LinuxKongress2002/Tutorial/IV.Foomatic-Developer/IV.tutorial-handout-foomatic-development.html Foomatic from the Developer's View].
With the kernel modules installed, you can now [[Daemon#Performing daemon actions manually|start the cupsd daemon]]. Add {{ic|cupsd}} to your [[daemons#Starting on Boot|DAEMONS array]] so it starts automatically on boot.
 
  
=== Web interface and tool-kit ===
+
To use foomatic, install {{pkg|foomatic-db-engine}} and at least one of:
  
Once the daemon is running, open a browser and go to: http://localhost:631 (''The '''localhost''' string may need to be replaced with the hostname found in'' {{ic|/etc/hosts}}).
+
* {{pkg|foomatic-db}} - a collection of XML files used by foomatic-db-engine to generate PPD files.
 +
* {{pkg|foomatic-db-ppds}} - prebuilt PPD files.
 +
* {{Pkg|foomatic-db-nonfree}} - a collection of XML files from printer manufacturers under non-free licenses used by foomatic-db-engine to generate PPD files.
 +
* {{pkg|foomatic-db-nonfree-ppds}} - prebuilt PPD files under non-free licenses.
  
From here, follow the various wizards to add the printer. A usual procedure is to start by clicking on ''Adding Printers and Classes'' and then ''Add Printer''.  When prompted for a username and password, log in as root. The name assigned to the printer does not matter, the same applies for 'location' and 'description'. Next, a list of devices to select from will be presented. The actual name of the printer shows up next to the label ( e.g., next to ''USB Printer #1'' for USB printers). Finally, choose the appropriate drivers and the configuration is complete.
+
The foomatic PPDs may require additional filters, such as {{aur|min12xxw}}.
  
Now test the configuration by pressing the ''Maintenance'' drop-down menu then ''Print Test Page''. If it does not print and there is certainty regarding the correctness of applied settings, then the problem is most likely due to missing a proper printer driver.
+
=== Gutenprint ===
  
{{Tip|See: [[#Alternative CUPS interfaces]] for other other frontends.}}
+
The [http://gimp-print.sourceforge.net/ Gutenprint project] provides drivers for Canon, Epson, Lexmark, Sony, Olympus, and PCL printers for use with CUPS and [[GIMP]].
{{Note|When setting up a USB printer, you should see your printer listed on ''Add Printer'' page. If you can only see a "SCSI printer" option, it probably means that CUPS has failed to recognize
 
your printer.}}
 
  
{{Note|To enable wireless scanning on certain HP multifunction devices using the [http://www.archlinux.org/packages/extra/i686/hplip/ hplip] package, you may need to add the printer as a Network Printer using the http:// protocol. To determine the proper URI to use, run the {{ic|hp-makeuri}} command.}}
+
Install {{Pkg|gutenprint}} and {{Pkg|foomatic-db-gutenprint-ppds}}.
  
 +
{{Note|When the Gutenprint packages get updated, the printers using Gutenprint drivers will stop working until you run {{ic|cups-genppdupdate}} as root and restart CUPS. ''cups-genppdupdate'' will update the PPD files of the configured printers, see {{man|8|cups-genppdupdate}} for more details.}}
  
==== CUPS administration ====
+
=== Manufacturer-specific drivers ===
  
A username and password will be required when administering the printer in the web interface, such as: adding or removing printers, stopping print tasks, etc. The default username is the one assigned in the ''sys'' group, or root (change this by editing {{ic|/etc/cups/cupsd.conf}} in the line of ''SystemGroup'').  
+
Many printer manufacturers supply their own Linux drivers. These are often available in the official Arch repositories or in the [[AUR]].
  
If the root account has been locked (i.e. when using sudo), it is not possible to log in the CUPS administration interface with the default username and password. In this case, follow [http://www.cups.org/articles.php?L237+T+Qprintadmin these instructions] on the CUPS FAQ.  You might also want to read [http://bbs.archlinux.org/viewtopic.php?id=35567 this post].
+
Some of those drivers are described in more detail in [[CUPS/Printer-specific problems]].
  
====Remote access to web interface====
+
== Printer URI ==
By default, the CUPS web interface can only be accessed by the ''localhost''; i.e. the computer that it is installed on. To remotely access the interface, make the following changes to the {{ic|/etc/cups/cupsd.conf}} file. Replace the line:
 
Listen localhost:631
 
with
 
Port 631
 
so that CUPS listens to incoming requests.
 
  
Three levels of access can be granted:
+
Listed below are additional steps to manually generate the URI if required. Some printers or drivers may need a special URI as described in [[CUPS/Printer-specific problems]].
<Location />          #access to the server
 
<Location /admin> #access to the admin pages
 
<Location /admin/conf> #access to configuration files
 
  
To give remote hosts access to one of these levels, add an {{ic|Allow}} statement to that level's section. An {{ic|Allow}} statement can take one or more of the forms listed below:
+
=== USB ===
Allow all
 
Allow host.domain.com
 
Allow *.domain.com
 
Allow ip-address
 
Allow ip-address/netmask
 
  
Deny statements can also be used. For example, if wanting to give all hosts on the 192.168.1.0/255.255.255.0 subnet full access, file {{ic|/etc/cups/cupsd.conf}} would include this:
+
CUPS should be able to automatically generate a URI for USB printers, for example {{ic|1=usb://HP/DESKJET%20940C?serial=CN16E6C364BH}}.
# Restrict access to the server...
 
# By default only localhost connections are possible
 
<Location />
 
    Order allow,deny
 
    Allow From localhost
 
    '''Allow From 192.168.1.0/255.255.255.0'''
 
</Location>
 
 
# Restrict access to the admin pages...
 
<Location /admin>
 
    # Encryption disabled by default
 
    #Encryption Required
 
    Order allow,deny
 
    Allow From localhost
 
    '''Allow From 192.168.1.0/255.255.255.0'''
 
</Location>
 
 
# Restrict access to configuration files...
 
<Location /admin/conf>
 
    AuthType Basic
 
    Require user @SYSTEM
 
    Order allow,deny
 
    Allow From localhost
 
    '''Allow From 192.168.1.0/255.255.255.0'''
 
</Location>
 
  
You might also need to add:
+
If it does not, see [[CUPS/Troubleshooting#USB printers]] for troubleshooting steps.
  
DefaultEncryption Never
+
=== Parallel port ===
  
This should avoid the error: 426 - Upgrade Required when using the CUPS web interface from a remote machine.
+
The URI should be of the form {{ic|parallel:''device''}}. For instance, if the printer is connected on {{ic|/dev/lp0}}, use {{ic|parallel:/dev/lp0}}.
 +
If you are using a USB to parallel port adapter, use {{ic|parallel:/dev/usb/lp0}} as the printer URI.
  
==Troubleshooting==
+
=== Network ===
The best way to get printing working is to set 'LogLevel' in {{ic|/etc/cups/cupsd.conf}} to:
 
LogLevel debug
 
  
And then viewing the output from {{ic|/var/log/cups/error_log}} like this:
+
If you have set up [[Avahi]] as in [[#Network]], CUPS should detect the printer URI. You can also use {{ic|avahi-discover}} to find the name of your printer and its address (for instance, {{ic|BRN30055C6B4C7A.local/10.10.0.155:631}}).
# tail -n 100 -f /var/log/cups/error_log
 
  
The characters at the left of the output stand for:
+
The URI can also be generated manually, without using [[Avahi]].
*D=Debug
+
A list of the available URI schemes for networked printers is available in the [https://www.cups.org/doc/network.html#PROTOCOLS CUPS documentation]. As exact details of the URIs differ between printers, check either the manual of the printer or [[CUPS/Printer-specific problems]].
*E=Error
 
*I=Information
 
*And so on
 
  
These files may also prove useful:
+
The URI for printers on [[SMB]] shares is described in the {{man|8|smbspool}} man page.
*{{ic|/var/log/cups/page_log}} -  Echoes a new entry each time a print is successful
 
*{{ic|/var/log/cups/access_log}} - Lists all cupsd http1.1 server activity
 
  
Of course, it is important to know how CUPS works if wanting to solve related issues:
+
Remote CUPS print servers can be accessed through a URI of the form {{ic|ipp://''hostname'':631/printers/''queue_name''}}. See [[CUPS/Printer sharing#Printer sharing]] for details on setting up the remote print server.
# An application sends a .ps file (PostScript, a script language that details how the page will look) to CUPS when 'print' has been selected (this is the case with most programs).
 
# CUPS then looks at the printer's PPD file (printer description file) and figures out what filters it needs to use to convert the .ps file to a language that the printer understands (like PJL, PCL), usually GhostScript.
 
# GhostScript takes the input and figures out which filters it should use, then applies them and converts the .ps file to a format understood by the printer.
 
# Then it is sent to the back-end. For example, if the printer is connected to a USB port, it uses the USB back-end.
 
  
Print a document and watch {{ic|error_log}} to get a more detailed and correct image of the printing process.
+
See [[CUPS/Troubleshooting#Networking issues]] for additional issues and solutions.
  
===Problems resulting from upgrades===
+
{{Warning|1=Avoid configuring both the server and the client with a printer filter - either the print queue on the client or the server should be 'raw'. This avoids sending a print job through the filters for a printer twice, which can cause problems (for instance, [https://bbs.archlinux.org/viewtopic.php?pid=1589908#p1589908]). See [[#Usage]] for an example of setting a print queue to 'raw'.}}
''Issues that appeared after CUPS and related program packages underwent a version increment''
 
  
====CUPS stops working====
+
== Usage ==
The chances are that a new configuration file is needed for the new version to work properly. Messages such as "404 - page not found" may result from trying to manage CUPS via localhost:631, for example.
 
  
To use the new configuration, copy /etc/cups/cupsd.conf.default to /etc/cups/cupsd.conf (backup the old configuration if needed):
+
CUPS can be fully controlled using the lp* and cups* CLI tools.
# cp /etc/cups/cupsd.conf.default /etc/cups/cupsd.conf
+
Alternatively, the [[#Web interface]] or one of several [[#GUI applications]] can be used.
and restart CUPS to employ the new settings.
 
  
====All jobs are "stopped"====
+
* The ''queue'' name is a short but descriptive name used on the system to identify the queue. This name should not contain spaces or any special characters. For instance, a print queue corresponding to a HP LaserJet 5P could be named "hpljet5p". More than one queue can be associated with each physical printer.
If all jobs sent to the printer become "stopped", delete the printer and add it again.
+
* The ''location'' is a description of the printer's physical location (for instance "bedroom", or "kitchen"). This is to aid in maintaining several printers.
Using the [http://localhost:631 CUPS web interface], go to Printers > Delete Printer.
+
* The ''description'' is a full description of the print queue. A common use is a full printer name (like "HP LaserJet 5P").
  
To check the printer's settings go to ''Printers'', then ''Modify Printer''. Copy down the information displayed, click 'Modify Printer' to proceed to the next page(s), and so on.
+
=== CLI tools ===
  
====All jobs are "The printer is not responding"====
+
See [http://localhost:631/help/options.html CUPS local documentation] for more tips on the command-line tools.
On networked printers, you should check that the name that CUPS uses as its connection URI resolves to the printer's IP via DNS, e.g.
 
If your printer's connection looks like this:
 
lpd://BRN_020554/BINARY_P1
 
  
then the hostname 'BRN_020554' needs to resolve to the printer's IP from the server running CUPS
+
{{Note|Command-line switches cannot be grouped}}
  
====The PPD version is not compatible with gutenprint====
+
{{Style|Nonstandard use of definition lists, comments in command line.}}
Run:
 
# /usr/sbin/cups-genppdupdate
 
  
And restart CUPS (as pointed out in gutenprint's post-install message)
+
;List the devices
 +
# lpinfo -v
 +
$ /usr/lib/cups/backend/snmp ''ip_address''  # Use SNMP to find a URI
  
===USB printers under CUPS 1.4.x===
+
;List the models
New CUPS 1.4.x introduces many changes:
+
$ lpinfo -m
  
====Device node permissions====
+
;Add a new queue
Some device may not be set with proper permission, escpecially when you blacklist the usblp module (no more needed as of cups version 1.6.x). CUPS needs the ownership of the USB device file of the printer to be root:lp, and permissions to be 660, e.g.
+
  # lpadmin -p ''queue_name'' -E -v ''uri'' -m ''model''
  $ ls -l /dev/bus/usb/003/002
 
crw-rw---- 1 root lp 189, 257 20. Okt 10:32 /dev/bus/usb/003/002
 
  
This is supposed to be achieved by two udev rules in /lib/udev/rules.d/50-udev-default.rules:
+
The ''queue_name'' is up to you.
  # hplip and cups 1.4+ use raw USB devices, so permissions should be similar to
+
Examples:
  # the ones from the old usblp kernel module
+
# lpadmin -p HP_DESKJET_940C -E -v "usb://HP/DESKJET%20940C?serial=CN16E6C364BH" -m drv:///HP/hp-deskjet_940c.ppd.gz
  SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ENV{ID_USB_INTERFACES}=="", IMPORT{program}="usb_id --export %p"
+
  # lpadmin -p AirPrint -E -v "ipp://10.0.1.25/ipp/print" -m everywhere    # Driverless queue (Apple AirPrint or IPP Everywhere)
SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ENV{ID_USB_INTERFACES}==":0701*:", GROUP="lp", MODE="660"
+
  # lpadmin -p SHARED_PRINTER -m raw    # Raw queue; no PPD or filter
 +
  # lpadmin -p Test_Printer -E -v "ipp://10.0.1.3/ipp/print" -m pxlmono.ppd    # Specifying a PPD instead of a model
  
However, for some devices, in particular combined printer/scanner devices, these rules either do not trigger, or are overwritten by rules of the 'sane' package. In these cases a custom udev rule needs to be added. See below.
+
{{Note|When specifying the PPD, use just the file name and not the full path (for instance, {{ic|pxlmono.ppd}} instead of {{ic|/usr/share/ppd/cupsfilters/pxlmono.ppd}}). Alternatively, the full path can be used with the {{ic|-P}} command line switch.}}
  
=====Device node permission troubleshooting=====
+
;Set the default printer
Get the printer's device file and its permissions with:
+
  $ lpoptions -d ''queue_name''
$ lsusb
 
...
 
Bus 003 Device 002: ID 04b8:0841 Seiko Epson Corp.
 
  $ ls -l /dev/bus/usb/003/002
 
crw-rw---- 1 root lp 189, 257 20. Okt 10:32 /dev/bus/usb/003/002
 
  
If the permissions are not already root:lp 660, enforce it by creating a custom udev rule, e.g.
+
;Change the options
  cat /etc/udev/rules.d/10-usbprinter.rules
+
  $ lpoptions -p ''queue_name'' -l # List the options
  ATTR{idVendor}=="04b8", ATTR{idProduct}=="0841", MODE:="0660", GROUP:="lp"
+
  $ lpoptions -p ''queue_name'' -o ''option''=''value'' # Set an option
  
If you have a multifunction device (printer+scanner) you need to make the device detectable to sane too
+
Example:
  cat /etc/udev/rules.d/10-usbprinter.rules
+
  $ lpoptions -p HP_DESKJET_940C -o PageSize=A4
ATTR{idVendor}=="04b8", ATTR{idProduct}=="0841", MODE:="0660", GROUP:="lp", ENV{libsane_matched}:="yes"
 
  
{{Note|
+
;Check the status
* {{ic|idVendor}} and {{ic|idProduct}} are from the {{ic|lsusb}} listing above.
+
$ lpstat -s
* some printers will need permissions to be {{ic|666}}
+
$ lpstat -p ''queue_name''
* on my machine the propper folder is {{ic|/usr/lib/udev/rules.d}}
 
}}
 
  
=====Loading firmware=====
+
;Deactivate a printer
 +
# cupsdisable ''queue_name''
  
Some printers and drivers need to load firmware to the printer (such as HP LaserJet 10xx printers using foo2zjs) and do this by writing directly to the lp device, a functionality provided by usblp.  A work around until this issue is resolved is to install the usblp module until the firmware is loaded, then remove the module to allow CUPS to work.  This can be accomplished by manually running "$ modprobe usblp", waiting for the firmware to load, then "$ rmmod usblp". You can also not blacklist usblp, then put "rmmod usblp" to /etc/rc.local, allowing the firmware to be loaded on boot before rc.local is run, then removing usblp.
+
;Activate a printer
 +
  # cupsenable ''queue_name''
  
In case the printer is plugged in or powered on while system is already running, /etc/rc.local does not get executed and usblp module stays loaded. A workaround is to modify the /etc/udev/rules.d/11-hpj10xx.rules provided by foo2zjs so that after the add event we wait, e.g. 15 seconds for the firmware to load and then automatically remove usblp. The following example is for HP LaserJet 1018. For other models the value of ATTRS{idProduct} should be changed to match the printer model.
+
;Set the printer to accept jobs
 +
# cupsaccept ''queue_name''
  
Locate the line matching your printer in /etc/udev/rules.d/11-hpj10xx.rules:
+
;Remove a printer
  ACTION=="add", KERNEL=="lp*", SUBSYSTEM=="usb", ATTRS{idVendor}=="03f0",    \
+
First set it to reject all incoming entries:
        ATTRS{idProduct}=="4117", RUN+="/sbin/foo2zjs-loadfw 1018 $tempnode"
+
  # cupsreject ''queue_name''
Add the following lines below it, make sure match the product and vendor IDs:
+
Then disable it.
  ACTION=="add", KERNEL=="lp*", SUBSYSTEM=="usb", ATTRS{idVendor}=="03f0",    \
+
  # cupsdisable ''queue_name''
        ATTRS{idProduct}=="4117", RUN+="/usr/bin/sleep 15"
+
Finally remove it.
  ACTION=="add", KERNEL=="lp*", SUBSYSTEM=="usb", ATTRS{idVendor}=="03f0",    \
+
  # lpadmin -x ''queue_name''
        ATTRS{idProduct}=="4117", RUN+="/usr/bin/rmmod usblp"
 
  
Update: these modifications are not needed using foo2zjs>=20120519-2 AUR package as the /etc/udev/rules.d/11-hpj10xx.rules is already patched!!!
+
;Print a file
 +
$ lpr ''file''
 +
$ lpr -# 17 ''file''            # print the file 17 times
 +
$ echo 'Hello, world!' | lpr -p # print the result of a command. The -p switch adds a header.
  
===Other===
+
;Check the queue
 +
$ lpq
 +
$ lpq -a # on all queues
  
=====CUPS permission errors=====
+
;Clear the queue
*Some users fixed 'NT_STATUS_ACCESS_DENIED' (Windows clients) errors by using a slightly different syntax:
+
# lprm  # remove last entry only
  smb://workgroup/username:password@hostname/printer_name
+
  # lprm - # remove all entries
  
*Sometimes, the block device has wrong permissions:
+
=== Web interface ===
# ls /dev/usb/
 
lp0
 
# chgrp lp /dev/usb/lp0
 
  
====HPLIP printer sends "/usr/lib/cups/backend/hp failed" error====
+
The CUPS server can be fully administered through the web interface, available on http://localhost:631/.
Make sure dbus is installed and running, e.g. check DAEMONS in {{ic|/etc/rc.conf}} or run {{ic|ls /var/run/daemons}}.
 
  
The avahi-daemon might be required if this error persists and the dbus is already running.
+
{{Note|If an HTTPS connection to CUPS is used, it ''may'' take a very long time before the interface appears the first time it is accessed. This is because the first request triggers the generation of SSL certificates which can be a time-consuming job.}}
  
Try adding the printer as a Network Printer using the http:// protocol. Generate the printer URI with {{ic|hp-makeuri}}.
+
To perform administrative tasks from the web interface authentication is required. Authenticate either as {{ic|root}} or make sure your user is member of a group with printer administration privileges, see [[#Configuration]].
  
{{Note|There might need to set permissions issues right. Follow indications here: [[CUPS#Device_node_permissions]].}}
+
;Add a queue
 +
Go to the '''Administration''' page.  
  
====HPLIP printer claims job is complete but printer does nothing====
+
;Modify existing queues
This happens on hp printers when you select the (old) hpijs driver (e.g. the Deskjet D1600 series). Instead, use the hpcups driver when adding the printer.
+
Go to the '''Printers''' page, and select a queue to modify.
  
====hp-toolbox sends an error, "Unable to communicate with device"====
+
;Test a queue
If running hp-toolbox as a regular user results in:
+
Go to the '''Printers''' page, and select a queue.
# hp-toolbox
 
# error: Unable to communicate with device (code=12): hp:/usb/<printer id>
 
or, "{{ic|Unable to communicate with device"}}", then it may be needed to [[Groups#Group_management|add the user to the lp group]].
 
  
This can also be caused by printers such as the P1102 that provide a virtual cd-rom drive for MS-Windows drivers. The lp dev appears and then disappears. In that case try the '''usb-modeswitch''' and '''usb-modeswitch-data''' packages, that lets one switch off the "Smart Drive" (udev rules included in said packages).
+
=== GUI applications ===
  
This can also occur with network attached printers if the [[Avahi|avahi-daemon]] is not running.
+
If your user does not have sufficient privileges to administer CUPS, the applications will request the root password when they start. To give users administrative privileges without needing root access, see [[#Configuration]].
  
====CUPS returns '"foomatic-rip" not available/stopped with status 3' with a HP printer====
+
* {{App|GtkLP|GTK interface for CUPS.|https://gtklp.sirtobi.com/index.shtml|{{AUR|gtklp}}}}
If receiving any of the following error messages in {{ic|/var/log/cups/error_log}} while using a HP printer, with jobs appearing to be processed while they all end up not being completed with their status set to 'stopped':
+
* {{App|print-manager|Tool for managing print jobs and printers ([[KDE]]).|https://cgit.kde.org/print-manager.git|{{Pkg|print-manager}}}}
Filter "foomatic-rip" for printer "<printer_name>" not available: No such file or director
+
* {{App|system-config-printer|GTK printer configuration tool and status applet.|http://cyberelk.net/tim/software/system-config-printer/|{{Pkg|system-config-printer}}}}
or:
 
PID 5771 (/usr/lib/cups/filter/foomatic-rip) stopped with status 3!
 
make sure '''hplip''' has been installed, in addition to [[#Packages|the packages mentioned above]], '''net-snmp''' is also needed. See [http://bbs.archlinux.org/viewtopic.php?id=65615 this forum post].
 
# pacman -S hplip
 
  
====Printing fails with unauthorised error====
+
== Configuration ==
If the user has been added to the lp group, and allowed to print (set in {{ic|cupsd.conf}}), then the problem lies in {{ic|/etc/cups/printers.conf}}. This line could be the culprit:
 
AuthInfoRequired negotiate
 
  
Comment it out and restart CUPS.
+
The CUPS server configuration is located in {{ic|/etc/cups/cupsd.conf}} and {{ic|/etc/cups/cups-files.conf}} (see {{man|5|cupsd.conf}} and {{man|5|cups-files.conf}}). After editing either file, [[restart]] {{ic|org.cups.cupsd.service}} to apply any changes. The default configuration is sufficient for most users.
  
====Print button greyed-out in GNOME print dialogs====
+
[[User group]]s with printer administration privileges are defined in {{ic|SystemGroup}} in the {{ic|/etc/cups/cups-files.conf}}. The {{ic|sys}} and {{ic|root}} [[groups]] are used by default.
:''<small>Source: [http://bbs.archlinux.org/viewtopic.php?id=70418 I can't print from gnome applications. - Arch Forums]</small>''
 
  
Be sure the package: '''libgnomeprint''' is installed
+
{{pkg|cups}} is built with {{pkg|libpaper}} support and libpaper defaults to the '''Letter''' paper size. To avoid having to change the paper size for each print queue you add, edit {{ic|/etc/papersize}} and set your system default paper size. See {{man|5|papersize}}.
  
Edit {{ic|/etc/cups/cupsd.conf}} and add
+
By default, all logs are sent to files in {{ic|/var/log/cups/}}. By changing the values of the {{ic|AccessLog}}, {{ic|ErrorLog}}, and {{ic|PageLog}} directives in {{ic|/etc/cups/cups-files.conf}} to {{ic|syslog}}, CUPS can be made to log to the [[systemd journal]] instead. See [https://fedoraproject.org/wiki/Changes/CupsJournalLogging the fedora wiki page] for information on the original proposed change.
# HostNameLookups Double
 
  
Restart CUPS:
+
=== cups-browsed ===
# /etc/rc.d/cupsd restart
 
  
====Unknown supported format: application/postscript====
+
{{Out of date|{{ic|cups-browsed.service}} is not required to discover printers advertised over DNS-SD, that is done by {{ic|org.cups.cupsd.service}}. The service is only required to discover printers on an LDAP server and those using the legacy CUPS protocol (CUPS servers ≤ 1.5).}}
Comment the lines:
 
application/octet-stream        application/vnd.cups-raw        0      -
 
from {{ic|/etc/cups/mime.convs}}, and:
 
application/octet-stream
 
in {{ic|/etc/cups/mime.types}}.
 
  
====Finding URIs for Windows Print Servers====
+
CUPS can use [[Avahi]] browsing to discover unknown shared printers in your network. This can be useful in large setups where the server is unknown. To use this feature, set up [[Avahi#Hostname_resolution|.local hostname resolution]], and start both {{ic|avahi-daemon.service}} and {{ic|cups-browsed.service}}. Jobs are sent directly to the printer without any processing so the created queues may not work, however driverless printers such as those supporting [http://www.pwg.org/ipp/everywhere.html IPP Everywhere] or [[wikipedia:AirPrint|AirPrint]] should work out of the box.
  
Sometimes Windows is a little less than forthcoming about exact device URIs (device locations).  If having trouble specifying the correct device location in CUPS, run the following command to list all shares available to a certain windows username:
+
{{Note|1=<nowiki></nowiki>
$ smbtree -U ''windowsusername''
+
* Searching for network printers [https://bbs.archlinux.org/viewtopic.php?pid=1720219#p1720219 may significantly increase the time it takes for your computer to boot].
This will list every share available to a certain Windows username on the local area network subnet, as long as Samba is set up and running properly.  It should return something like this:
+
* {{ic|cups-browsed.service}} is only needed to dynamically add and remove printers as they appear and disappear from a network. It is not required if you simply want to add a an DNS-SD/mDNS supporting network printer to CUPS.
{{bc| WORKGROUP
+
}}
\\REGULATOR-PC 
 
\\REGULATOR-PC\Z             
 
\\REGULATOR-PC\Public       
 
\\REGULATOR-PC\print$        Printer Drivers
 
\\REGULATOR-PC\G             
 
\\REGULATOR-PC\EPSON Stylus CX8400 Series EPSON Stylus CX8400 Series}}
 
What is needed here is first part of the last line, the resource matching the printer description.  So to print to the EPSON Stylus printer, one would enter:
 
smb://username.password@REGULATOR-PC/EPSON Stylus CX8400 Series
 
as the URI into CUPS. Notice that whitespaces are allowed in URIs, whereas backslashes get replaced with forward slashes.
 
 
 
====Print-Job client-error-document-format-not-supported====
 
Try installing the foomatic packages and use a foomatic driver.
 
 
 
====/usr/lib/cups/backend/hp failed====
 
Change
 
  SystemGroup sys root
 
to
 
  SystemGroup lp root
 
in {{ic|/etc/cups/cupsd.conf}}
 
 
 
 
 
Following steps 1-3 in the Alternative CUPS interfaces below may be a better solution, since newer versions of cups will not allow the same group for both normal and admin operation.
 
 
 
===="Unable to get list of printer drivers"====
 
Try to remove Foomatic drivers.
 
 
 
==Appendix==
 
 
 
===Alternative CUPS interfaces===
 
If using [[GNOME]], a possibility is to manage and configure the printer by using system-config-printer-gnome. This package is available through pacman:
 
# pacman -S system-config-printer-gnome
 
 
 
For system-config-printer to work as it should, running as root may be required, or alternatively set up a "normal" user to administer CUPS (if so '''follow steps 1-3''')
 
 
 
* 1. Create group, and add a user to it
 
# groupadd lpadmin
 
# usermod -aG lpadmin <username>
 
  
* 2. Add "lpadmin" (without the quotes) to this line in {{ic|/etc/cups/cupsd.conf}}
+
=== Print servers and remote administration ===
SystemGroup sys root <insert here>
 
  
* 3. Restart cups, log out and in again (or restart computer)
+
See [[CUPS/Printer sharing]] and [[CUPS/Printer sharing#Remote administration]].
{{bc|# rc.d restart cupsd}}
 
  
[[KDE]] users can modify their printers from the Control Center. Both should refer to those desktop environments' documentation for more information on how to use the interfaces.
+
=== Allowing admin authentication through PolicyKit ===
  
There is also [https://aur.archlinux.org/packages.php?ID=43505 gtklp] in the [[AUR]]
+
[[PolicyKit]] can be configured to allow users to configure printers using a GUI without the admin password.
  
===PDF virtual printer===
+
{{Note|1=You may need to install {{Pkg|cups-pk-helper}} for working this rules.}}
CUPS-PDF is a nice package that allows one to setup a virtual printer that will generate a PDF from anything sent to it. Obviously this package is not necessary, but it can be quite useful.
 
  
Find generated PDF documents in a sub-directory located at {{ic|/var/spool/cups-pdf}}. Normally, the subdirectory is named after the user who performed the job. A little tweak helps you to find your printed PDF documents more easily. Edit /etc/cups/cups-pdf.conf by changing the line
+
Here is an example that allows members of the wheel [[user group]] to administer printers without a password:
#Out /var/spool/cups-pdf/${USER}
 
  
to
+
{{hc|/etc/polkit-1/rules.d/49-allow-passwordless-printer-admin.rules|<nowiki>
 +
polkit.addRule(function(action, subject) {
 +
    if (action.id == "org.opensuse.cupspkhelper.mechanism.all-edit" &&
 +
        subject.isInGroup("wheel")){
 +
        return polkit.Result.YES;
 +
    }
 +
});
 +
</nowiki>}}
  
Out /home/${USER}
+
=== Without a local CUPS server ===
  
This package can be installed by the following command:
+
CUPS can be configured to directly connect to remote printer servers instead of running a local print server. This requires [[install]]ation of the {{Pkg|libcups}} package. Some applications will still require the {{Pkg|cups}} package for printing.
# pacman -S cups-pdf
 
  
After installing the package, set it up as if it were for any other printer by using the web interface. For the Device, select '''CUPS-PDF (Virtual PDF Printer)'''; Make/Manufacturer, choose '''Generic'''; Model/Driver, select '''Generic postscript color printer''' or '''Generic Cups-PDF Printer'''. Alternatively, provide the PPD file from [http://www.physik.uni-wuerzburg.de/~vrbehr/cups-pdf/cups-pdf-CURRENT/extra/CUPS-PDF.ppd this link].
+
{{Warning|Accessing remote printers without a local CUPS server is not recommended by the developers. [https://lists.cups.org/pipermail/cups/2015-October/027229.html]}}
  
==== Print to postscript: CUPS-PDF virtual printer trick ====
+
To use a remote CUPS server, set the {{ic|CUPS_SERVER}} [[environment variable]] to {{ic|printerserver.mydomain:port}}. For instance, if you want to use a different print server for a single [[Firefox]] instance (substitute {{ic|printserver.mydomain:port}} with your print server name/port):
  
Printing to PDF in most applications like OpenOffice is no problem; just hit the button. Yet when printing out to postscript, matters take a little more work. For applications like OpenOffice where printing to kprinter is nebulous at best, there has to be another way -- and there is. The CUPS-PDF (Virtual PDF Printer) actually creates a postscript file and then creates the PDF using the ps2pdf utility. To print to postscript, what needs to be done is capturing the intermediate postscript file created by CUPS-PDF. This is easily accomplished with by selecting the "print to file" option in the print dialog. (choose either .ps or .eps as the extension) After selecting the "print to file" checkbox simply enter the filename and click "print".
+
$ CUPS_SERVER=printserver.mydomain:port firefox
  
=====Configuring CUPS-PDF virtual printer=====
+
== Troubleshooting ==
#Set up the cups daemon using the instructions on this page.
 
#Install {{Pkg|cups-pdf}} from [extra].
 
#Access the cups print manager: http://localhost:631 and select:
 
Administration -> Add Printer
 
Select CUPS-PDF (Virtual PDF), choose for the make and driver:
 
Make: Generic
 
Driver: Generic CUPS-PDF Printer
 
  
Now to print to postscript, just print as usual, in the print dialog choose "CUPS-PDF" as the printer, then select the checkbox for "print to file", hit print, enter the filename.ps and click save. This is handy for faxes, etc...
+
See [[CUPS/Troubleshooting]].
  
===Another source for printer drivers===
+
== See also ==
[http://www.turboprint.de/english.html Turboprint] is a proprietary driver for many printers not yet supported by GNU/Linux (Canon i*, for example). Unlike CUPS, however, high quality prints are either marked with a watermark or are a pay-only service.
 
  
==See also==
+
* [http://localhost:631/help Official CUPS documentation], ''locally installed''
* [http://localhost:631/documentation.html Official CUPS documentation], ''locally installed''
+
* [[Wikipedia:CUPS]]
* [http://www.cups.org/ Official CUPS Website]
+
* [http://www.linuxfoundation.org/collaborate/workgroups/openprinting OpenPrinting homepage]
* [http://www.linuxprinting.org/ Linux Printing], ''[http://www.linuxfoundation.org The Linux Foundation]''
+
* [https://en.opensuse.org/Concepts_printing OpenSuSE Concepts printing guide - explains the full printing workflow]
* [http://www.gentoo.org/doc/en/printing-howto.xml Gentoo's Printing Guide], ''[http://www.gentoo.org/doc/en  Gentoo Documentation Resources]''
+
* [https://en.opensuse.org/SDB:CUPS_in_a_Nutshell OpenSuSE CUPS in a Nutshell - a quick CUPS overview]
* [http://bbs.archlinux.org/ Arch Linux User Forums]
+
* [https://wiki.gentoo.org/wiki/Printing Gentoo's printing guide]
* [http://wiki.gotux.net/config/hp-printer Install HP Printers Easy Way]
+
* [[debian:Printing|Debian's Printing portal - detailed technical guides]]
 +
* [[debian:SystemPrinting|Debian's printing overview - a basic view of the CUPS printing system]]

Latest revision as of 19:05, 20 August 2019

CUPS is the standards-based, open source printing system developed by Apple Inc. for macOS® and other UNIX®-like operating systems.

Installation

Install the cups package.

If you intend to "print" into a PDF document, also install the cups-pdf package. By default, pdf files are stored in /var/spool/cups-pdf/username/. The location can be changed in /etc/cups/cups-pdf.conf.

Enable and start org.cups.cupsd.service.

Socket activation

cups provides a org.cups.cupsd.socket unit. If org.cups.cupsd.socket is enabled (and org.cups.cupsd.service is disabled), systemd will not start CUPS immediately, it will just listen to the appropriate sockets. Then, whenever a program attempts to connect to one of these CUPS sockets, systemd will start org.cups.cupsd.service and transparently hand over control of these ports to the CUPS process.

This way, CUPS is only started once a program wants to make use of the service.

Connection Interfaces

Additional steps for printer detection are listed below for various connection interfaces.

Note:
  • CUPS helper programs are run using the cups user and group. This allows the helper programs to access printer devices and read config files in /etc/cups/, which are owned by the cups group.
  • Prior to cups 2.2.6-2, the lp group was used instead. After the upgrade, the files in /etc/cups should be owned by the cups group and User 209 and Group 209 set in /etc/cups/cups-files.conf.

USB

To see if your USB printer is detected:

$ lsusb
(...)
Bus 001 Device 007: ID 03f0:1004 Hewlett-Packard DeskJet 970c/970cse

Parallel port

To use a parallel port printer, the lp, parport and parport_pc kernel modules are required.

$ dmesg | grep -i parport
 parport0: Printer, Hewlett-Packard HP LaserJet 2100 Series
 lp0: using parport0 (polling)

Network

To discover or share printers using DNS-SD/mDNS, setup .local hostname resolution with Avahi and restart org.cups.cupsd.service.

Note: DNS-SD is only supported when using Avahi. CUPS does not support using systemd-resolved for DNS-SD, see CUPS issue 5452.

To share printers with Samba, e.g. if the system is to be a print server for Windows clients, the samba package will be required.

Printer Drivers

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: CUPS 2.3 will drop PPD and driver support (CUPS issue 5271), instead relying entirely on IPP Everywhere. Explain what is/will be handled by cups and what by cups-filters and/or other software. (Discuss in Talk:CUPS#)


The drivers for a printer may come from any of the sources shown below. See CUPS/Printer-specific problems for an incomplete list of drivers that others have managed to get working.

To drive a printer, CUPS needs a PPD file and, for most printers, some filters. For details on how CUPS uses PPDs and filters, see [1].

The OpenPrinting Printer List provides driver recommendations for many printers. It also supplies PPD files for each printer, but most are available through foomatic or the recommended driver package.

When a PPD file is provided to CUPS, the CUPS server will regenerate the PPD files and save them in /etc/cups/ppd/.

CUPS

CUPS includes support for AirPrint and IPP Everywhere printers.

OpenPrinting CUPS filters

The Linux Foundation's OpenPrinting workgroup provides cups-filters. Those are backends, filters, and other binaries that were once part of CUPS but are no longer maintained by Apple. They are available in the cups-filters package that is a dependency of cups.

Non-PDF printers require ghostscript to be installed. For PostScript printers gsfonts may also be required.

Foomatic

The Linux Foundation's OpenPrinting workgroup's foomatic provides PPDs for many printer drivers, both free and nonfree. For more information about what foomatic does, see Foomatic from the Developer's View.

To use foomatic, install foomatic-db-engine and at least one of:

The foomatic PPDs may require additional filters, such as min12xxwAUR.

Gutenprint

The Gutenprint project provides drivers for Canon, Epson, Lexmark, Sony, Olympus, and PCL printers for use with CUPS and GIMP.

Install gutenprint and foomatic-db-gutenprint-ppds.

Note: When the Gutenprint packages get updated, the printers using Gutenprint drivers will stop working until you run cups-genppdupdate as root and restart CUPS. cups-genppdupdate will update the PPD files of the configured printers, see cups-genppdupdate(8) for more details.

Manufacturer-specific drivers

Many printer manufacturers supply their own Linux drivers. These are often available in the official Arch repositories or in the AUR.

Some of those drivers are described in more detail in CUPS/Printer-specific problems.

Printer URI

Listed below are additional steps to manually generate the URI if required. Some printers or drivers may need a special URI as described in CUPS/Printer-specific problems.

USB

CUPS should be able to automatically generate a URI for USB printers, for example usb://HP/DESKJET%20940C?serial=CN16E6C364BH.

If it does not, see CUPS/Troubleshooting#USB printers for troubleshooting steps.

Parallel port

The URI should be of the form parallel:device. For instance, if the printer is connected on /dev/lp0, use parallel:/dev/lp0. If you are using a USB to parallel port adapter, use parallel:/dev/usb/lp0 as the printer URI.

Network

If you have set up Avahi as in #Network, CUPS should detect the printer URI. You can also use avahi-discover to find the name of your printer and its address (for instance, BRN30055C6B4C7A.local/10.10.0.155:631).

The URI can also be generated manually, without using Avahi. A list of the available URI schemes for networked printers is available in the CUPS documentation. As exact details of the URIs differ between printers, check either the manual of the printer or CUPS/Printer-specific problems.

The URI for printers on SMB shares is described in the smbspool(8) man page.

Remote CUPS print servers can be accessed through a URI of the form ipp://hostname:631/printers/queue_name. See CUPS/Printer sharing#Printer sharing for details on setting up the remote print server.

See CUPS/Troubleshooting#Networking issues for additional issues and solutions.

Warning: Avoid configuring both the server and the client with a printer filter - either the print queue on the client or the server should be 'raw'. This avoids sending a print job through the filters for a printer twice, which can cause problems (for instance, [2]). See #Usage for an example of setting a print queue to 'raw'.

Usage

CUPS can be fully controlled using the lp* and cups* CLI tools. Alternatively, the #Web interface or one of several #GUI applications can be used.

  • The queue name is a short but descriptive name used on the system to identify the queue. This name should not contain spaces or any special characters. For instance, a print queue corresponding to a HP LaserJet 5P could be named "hpljet5p". More than one queue can be associated with each physical printer.
  • The location is a description of the printer's physical location (for instance "bedroom", or "kitchen"). This is to aid in maintaining several printers.
  • The description is a full description of the print queue. A common use is a full printer name (like "HP LaserJet 5P").

CLI tools

See CUPS local documentation for more tips on the command-line tools.

Note: Command-line switches cannot be grouped

Tango-edit-clear.pngThis article or section needs language, wiki syntax or style improvements. See Help:Style for reference.Tango-edit-clear.png

Reason: Nonstandard use of definition lists, comments in command line. (Discuss in Talk:CUPS#)
List the devices
# lpinfo -v
$ /usr/lib/cups/backend/snmp ip_address  # Use SNMP to find a URI
List the models
$ lpinfo -m
Add a new queue
# lpadmin -p queue_name -E -v uri -m model

The queue_name is up to you. Examples:

# lpadmin -p HP_DESKJET_940C -E -v "usb://HP/DESKJET%20940C?serial=CN16E6C364BH" -m drv:///HP/hp-deskjet_940c.ppd.gz
# lpadmin -p AirPrint -E -v "ipp://10.0.1.25/ipp/print" -m everywhere    # Driverless queue (Apple AirPrint or IPP Everywhere)
# lpadmin -p SHARED_PRINTER -m raw    # Raw queue; no PPD or filter
# lpadmin -p Test_Printer -E -v "ipp://10.0.1.3/ipp/print" -m pxlmono.ppd    # Specifying a PPD instead of a model
Note: When specifying the PPD, use just the file name and not the full path (for instance, pxlmono.ppd instead of /usr/share/ppd/cupsfilters/pxlmono.ppd). Alternatively, the full path can be used with the -P command line switch.
Set the default printer
$ lpoptions -d queue_name
Change the options
$ lpoptions -p queue_name -l # List the options
$ lpoptions -p queue_name -o option=value # Set an option

Example:

$ lpoptions -p HP_DESKJET_940C -o PageSize=A4
Check the status
$ lpstat -s
$ lpstat -p queue_name
Deactivate a printer
# cupsdisable queue_name
Activate a printer
# cupsenable queue_name
Set the printer to accept jobs
# cupsaccept queue_name
Remove a printer

First set it to reject all incoming entries:

# cupsreject queue_name

Then disable it.

# cupsdisable queue_name

Finally remove it.

# lpadmin -x queue_name
Print a file
$ lpr file
$ lpr -# 17 file            # print the file 17 times
$ echo 'Hello, world!' | lpr -p # print the result of a command. The -p switch adds a header.
Check the queue
$ lpq
$ lpq -a # on all queues
Clear the queue
# lprm   # remove last entry only
# lprm - # remove all entries

Web interface

The CUPS server can be fully administered through the web interface, available on http://localhost:631/.

Note: If an HTTPS connection to CUPS is used, it may take a very long time before the interface appears the first time it is accessed. This is because the first request triggers the generation of SSL certificates which can be a time-consuming job.

To perform administrative tasks from the web interface authentication is required. Authenticate either as root or make sure your user is member of a group with printer administration privileges, see #Configuration.

Add a queue

Go to the Administration page.

Modify existing queues

Go to the Printers page, and select a queue to modify.

Test a queue

Go to the Printers page, and select a queue.

GUI applications

If your user does not have sufficient privileges to administer CUPS, the applications will request the root password when they start. To give users administrative privileges without needing root access, see #Configuration.

  • GtkLP — GTK interface for CUPS.
https://gtklp.sirtobi.com/index.shtml || gtklpAUR
  • print-manager — Tool for managing print jobs and printers (KDE).
https://cgit.kde.org/print-manager.git || print-manager
  • system-config-printer — GTK printer configuration tool and status applet.
http://cyberelk.net/tim/software/system-config-printer/ || system-config-printer

Configuration

The CUPS server configuration is located in /etc/cups/cupsd.conf and /etc/cups/cups-files.conf (see cupsd.conf(5) and cups-files.conf(5)). After editing either file, restart org.cups.cupsd.service to apply any changes. The default configuration is sufficient for most users.

User groups with printer administration privileges are defined in SystemGroup in the /etc/cups/cups-files.conf. The sys and root groups are used by default.

cups is built with libpaper support and libpaper defaults to the Letter paper size. To avoid having to change the paper size for each print queue you add, edit /etc/papersize and set your system default paper size. See papersize(5).

By default, all logs are sent to files in /var/log/cups/. By changing the values of the AccessLog, ErrorLog, and PageLog directives in /etc/cups/cups-files.conf to syslog, CUPS can be made to log to the systemd journal instead. See the fedora wiki page for information on the original proposed change.

cups-browsed

Tango-view-refresh-red.pngThis article or section is out of date.Tango-view-refresh-red.png

Reason: cups-browsed.service is not required to discover printers advertised over DNS-SD, that is done by org.cups.cupsd.service. The service is only required to discover printers on an LDAP server and those using the legacy CUPS protocol (CUPS servers ≤ 1.5). (Discuss in Talk:CUPS#)

CUPS can use Avahi browsing to discover unknown shared printers in your network. This can be useful in large setups where the server is unknown. To use this feature, set up .local hostname resolution, and start both avahi-daemon.service and cups-browsed.service. Jobs are sent directly to the printer without any processing so the created queues may not work, however driverless printers such as those supporting IPP Everywhere or AirPrint should work out of the box.

Note:

Print servers and remote administration

See CUPS/Printer sharing and CUPS/Printer sharing#Remote administration.

Allowing admin authentication through PolicyKit

PolicyKit can be configured to allow users to configure printers using a GUI without the admin password.

Note: You may need to install cups-pk-helper for working this rules.

Here is an example that allows members of the wheel user group to administer printers without a password:

/etc/polkit-1/rules.d/49-allow-passwordless-printer-admin.rules
polkit.addRule(function(action, subject) { 
    if (action.id == "org.opensuse.cupspkhelper.mechanism.all-edit" && 
        subject.isInGroup("wheel")){ 
        return polkit.Result.YES; 
    } 
});

Without a local CUPS server

CUPS can be configured to directly connect to remote printer servers instead of running a local print server. This requires installation of the libcups package. Some applications will still require the cups package for printing.

Warning: Accessing remote printers without a local CUPS server is not recommended by the developers. [3]

To use a remote CUPS server, set the CUPS_SERVER environment variable to printerserver.mydomain:port. For instance, if you want to use a different print server for a single Firefox instance (substitute printserver.mydomain:port with your print server name/port):

$ CUPS_SERVER=printserver.mydomain:port firefox

Troubleshooting

See CUPS/Troubleshooting.

See also