Difference between revisions of "CUPS"

From ArchWiki
Jump to: navigation, search
m (rc.d -> systemctl)
m (Printer Drivers: "Even when" suggests that a PPD might not be required - see https://bbs.archlinux.org/viewtopic.php?pid=1656180#p1656180)
 
(545 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
 
[[Category:Printers]]
 
[[Category:Printers]]
 
[[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]]
Line 9: Line 12:
 
[[zh-CN:CUPS]]
 
[[zh-CN:CUPS]]
 
[[zh-TW:CUPS]]
 
[[zh-TW:CUPS]]
{{Article summary start|Summary}}
+
{{Related articles start}}
{{Article summary text|Installing and configuring CUPS}}
+
{{Related|CUPS/Printer sharing}}
{{Article summary heading|Related}}
+
{{Related|CUPS/Printer-specific problems}}
{{Article summary wiki|CUPS printer sharing}}
+
{{Related|CUPS/Troubleshooting}}
{{Article summary wiki|CUPS printer-specific problems}}
+
{{Related|Samba}}
{{Article summary wiki|Samba}}
+
{{Related|LPRng}}
{{Article summary end}}
+
{{Related articles end}}
  
From [http://www.cups.org/index.php CUPS' site]:
+
[http://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 {{Pkg|cups}} version 1.5.3-3, Arch Linux 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].
+
  
There are two ways to setup a printer:
+
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/$USER}}. The location can be changed in {{ic|/etc/cups/cups-pdf.conf}}.
* 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==
+
[[Start]] and [[enable]] {{ic|org.cups.cupsd.service}}.
The package {{Pkg|libcups}} is the only required package. [[pacman|Install]] it from the [[Official repositories]].
+
  
Then add your CUPS server's IP address or hostname into {{ic|/etc/cups/client.conf}}. That is all you need. Every application should quickly find the printer(s) shared by that CUPS server.
+
== Connection Interfaces ==
 +
Additional steps for printer detection are listed below for various connection interfaces.
  
===Optional advanced network setup===
+
{{Note|CUPS helper programs are run using the {{ic|lp}} group and {{ic|daemon}} user. This allows the helper programs to access printer devices '''and''' read config files in {{ic|/etc/cups/}}, which all belong to the {{ic|lp}} group. This default may conflict with non-printer parallel port device access:
It is also possible to run a entire cupsd instance on your client with Avahi browsing enabled to discover unknown shared printers in your network. This can be useful in large setups where the server is unknown.
+
* Adding extra users to the {{ic|lp}} group will allow those users to read CUPS files, and
{{Note|This behavior did not change 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.}}
+
* CUPS helpers may gain access to any non-printer parallel port devices.
 +
If this is a concern, consider using a [[Udev]] rule to assign a different group for any non-printer parallel port device ({{Bug|50009}}). The group and user that CUPS uses can be changed, but the permissions of some files may need to be manually fixed.}}
  
==Installing the server packages==
+
=== USB ===
The packages {{Pkg|cups}}, {{Pkg|cups-filters}}, {{Pkg|ghostscript}}, {{Pkg|gsfonts}} and some printer driver are needed. [[pacman|Install]] them from the [[Official repositories]].
+
To see if your USB printer is detected:
 +
{{hc|$ lsusb|
 +
(...)
 +
Bus 001 Device 007: ID 03f0:1004 Hewlett-Packard DeskJet 970c/970cse
 +
}}
  
* '''cups''' - the actual CUPS daemon
+
=== Parallel port ===
* '''cups-filters''' - essential filters
+
To use a parallel port printer, the {{ic|lp}}, {{ic|parport}} and {{ic|parport_pc}} [[kernel modules]] are required.
* '''avahi''' - to make your printers browsable through your network
+
* '''ghostscript''' - (optional) PostScript interpreter
+
* '''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 as in [https://answers.launchpad.net/hplip/+question/133425 this thread].
+
  
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}}.
+
{{hc|$ dmesg {{!}} grep -i parport|
 +
parport0: Printer, Hewlett-Packard HP LaserJet 2100 Series
 +
lp0: using parport0 (polling)
 +
}}
  
As of cups version 1.6 avahi-daemon should be started before cupsd if you want to enable printer browsing through your network.
+
=== Network ===
 +
To use [[Avahi]] hostnames to connect to networked printers, set up [[Avahi#Hostname_resolution|.local hostname resolution]] and [[restart]] {{ic|org.cups.cupsd.service}}.
  
===Printer driver===
+
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, install the {{Pkg|samba}} package.
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 GhostScript, CUPS, Foomatic, and the [[GIMP]]
+
== Printer Drivers ==
* '''{{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!".
+
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.
* '''{{AUR|foo2zjs}}''' - Drivers for ZjStream protocol printers such as the HP Laserjet 1018. More info [http://foo2zjs.rkkda.com here]. Package is available in the [[AUR]].
+
* '''{{Pkg|hplip}}''' - HP drivers 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 such as the 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 you are not sure of what driver package to install or if the current driver is not working, it may be easiest to just install all of the drivers. Some of the package names are misleading because printers of other makes may rely on them. For example, the Brother HL-2140 needs the hplip driver installed.
+
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].
  
====Download printer PPD====
+
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 or the recommended driver package.
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:
+
When a PPD file is provided to CUPS, the CUPS server will regenerate the PPD files and save them in {{ic|/etc/cups/ppd/}}.
:"''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.''"
+
  
If the PPD for the printer is ''not'' already in CUPS, then:
+
=== CUPS ===
*check [[AUR]] to see if there are packages for the printer/manufacturer
+
CUPS provides a few PPDs and filter binaries by default, which should work out of the box.
*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/}}}}
+
=== Foomatic ===
 +
The [https://wiki.linuxfoundation.org/openprinting/database/foomatic foomatic] project 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].
  
==Configuring==
+
To use foomatic, install {{pkg|foomatic-db-engine}}, and at least one of {{pkg|foomatic-db-ppds}}, {{pkg|foomatic-db-nonfree-ppds}}, or {{pkg|foomatic-db-gutenprint-ppds}}.
Now that CUPS is installed, there are a variety of options on how to set up 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.
+
The foomatic PPDs may require additional filters, such as {{pkg|gutenprint}}, {{pkg|ghostscript}}, or another source (for instance {{aur|min12xxw}}).
 +
For {{pkg|ghostscript}}, {{pkg|gsfonts}} may also be required.
  
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])
+
=== Manufacturer-specific drivers ===
 +
Many printer manufacturers supply their own Linux drivers. These are often available in the official Arch repositories or in the [[AUR]].
  
===Kernel modules===
+
Some of those drivers are described in more detail in [[CUPS/Printer-specific problems]].
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.
+
== Printer URI ==
  
====USB printers====
+
Listed below are additional steps to manually generate the URI if required.
{{Warning|As of {{pkg|cups}} version 1.6.0, you no longer need to [[Kernel modules#Blacklisting|blacklist]] the {{ic|usblp}} kernel module.}}
+
If you find out this is the only way to fix a remaining issue please report this upstream to the CUPS bug 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:
+
=== USB ===
  
{{hc|/etc/modprobe.d/blacklist.conf|blacklist usblp}}
+
CUPS should be able to automatically generate a URI for USB printers, for example {{ic|1=usb://HP/DESKJET%20940C?serial=CN16E6C364BH}}.
  
Custom kernel users may need to manually load the {{ic|usbcore}} module before proceeding:
+
If it doesn't, see [[CUPS/Troubleshooting#USB printers]] for troubleshooting steps.
# modprobe usbcore
+
  
Once the modules are installed, plug in the printer and check if the kernel detected it by running the following:
+
=== Parallel port ===
# 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:
+
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}}.
Feb 19 20:17:11 kernel: printer.c: usblp0: USB Bidirectional
+
If you are using a USB to parallel port adapter, use {{ic|parallel:/dev/usb/lp0}} as the printer URI.
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:
+
=== Network ===
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====
+
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}}).
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 URI can also be generated manually, without using [[Avahi]].
# tail /var/log/messages.log
+
A list of the available URI schemes for networked printers is available in the CUPS documentation [https://www.cups.org/doc/network.html#PROTOCOLS]. As exact details of the URIs differ between printers, check either the manual of the printer or [[CUPS/Printer-specific problems]].
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 {{ic|/etc/cups/printers.conf}}:
+
Remote CUPS print servers can be accessed through a URI of the form {{ic|ipp://''hostname'':631/printers/''queue_name''}}. See [[CUPS/Printer sharing#Between GNU/Linux systems]] for details on setting up the remote print server.
DeviceID = parallel:/dev/usb/lp0
+
  
====Auto-loading====
+
See [[CUPS/Troubleshooting#Networking issues]] for additional issues and solutions.
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===
+
{{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'.}}
With the kernel modules installed, you can now [[Systemd#Using_units|start the cups service]]. You may want to enable the {{ic|cups}} service so that it  [[Daemon#Starting_on_Boot|starts automatically on boot]].
+
  
=== Web interface and tool-kit ===
+
== Usage ==
  
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}}).
+
CUPS can be fully controlled using the lp* and cups* command-line tools.
 +
Alternatively, the web interface or one of several GUI applications can be used.
  
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 ''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 printer. A common use is the full printer name (like "HP LaserJet 5P").
  
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.
+
=== CLI tools ===
  
{{Tip|See: [[#Alternative CUPS interfaces]] for other other front-ends.}}
+
See [http://localhost:631/help/options.html CUPS local documentation] for more tips on the command-line tools.
{{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 multi-function devices using the {{pkg|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.}}
+
{{Note|Command-line switches cannot be grouped}}
  
 +
;List the devices
 +
# lpinfo -v #
 +
$ /usr/lib/cups/backend/snmp ''ip_address'' # Use SNMP to find a URI
  
==== CUPS administration ====
+
;List the drivers
 +
$ lpinfo -m
  
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 {{ic|SystemGroup}}).
+
;Add a new queue
 +
# lpadmin -p ''queue_name'' -E -v ''uri'' -m ''model''
  
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 [https://bbs.archlinux.org/viewtopic.php?id=35567 this post].
+
The ''queue_name'' is up to you.
 +
Example:
 +
# lpadmin -p HP_DESKJET_940C -E -v "usb://HP/DESKJET%20940C?serial=CN16E6C364BH" -m drv:///HP/hp-deskjet_940c.ppd.gz
 +
# lpadmin -p SHARED_PRINTER -m raw    # Raw queue; no PPD or filter
  
====Remote access to web interface====
+
;Set the default printer
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:
+
$ lpoptions -d ''queue_name''
Listen localhost:631
+
with
+
Port 631
+
so that CUPS listens to incoming requests.
+
  
Three levels of access can be granted:
+
;Change the options
<Location />          #access to the server
+
  $ lpoptions -p ''queue_name'' -l # List the options
  <Location /admin> #access to the admin pages
+
  $ lpoptions -p ''queue_name'' -o ''option''=''value'' # Set an option
  <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:
+
Example:
  Allow from all
+
  $ lpoptions -p HP_DESKJET_940C -o PageSize=A4
Allow from host.domain.com
+
Allow from *.domain.com
+
Allow from ip-address
+
Allow from 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:
+
;Check the status
  # Restrict access to the server...
+
  $ lpstat -s
  # By default only localhost connections are possible
+
  $ lpstat -p ''queue_name''
<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:
+
;Deactivate a printer
 +
# cupsdisable ''queue_name''
  
  DefaultEncryption Never
+
;Activate a printer
 +
  # cupsenable ''queue_name''
  
This should avoid the error: 426 - Upgrade Required when using the CUPS web interface from a remote machine.
+
;Set the printer to accept jobs
 +
# cupsaccept ''queue_name''
  
==Troubleshooting==
+
;Remove a printer
The best way to get printing working is to set 'LogLevel' in {{ic|/etc/cups/cupsd.conf}} to:
+
First set it to reject all incoming entries:
  LogLevel debug
+
# cupsreject ''queue_name''
 +
Then disable it.
 +
  # cupsdisable ''queue_name''
 +
Finally remove it.
 +
# lpadmin -x ''queue_name''
  
And then viewing the output from {{ic|/var/log/cups/error_log}} like this:
+
;Print a file
  # tail -n 100 -f /var/log/cups/error_log
+
  $ 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.
  
The characters at the left of the output stand for:
+
;Check the queue
*D=Debug
+
$ lpq
*E=Error
+
$ lpq -a # on all queues
*I=Information
+
*And so on
+
  
These files may also prove useful:
+
;Clear the queue
*{{ic|/var/log/cups/page_log}} - Echoes a new entry each time a print is successful
+
  # lprm  # remove last entry only
*{{ic|/var/log/cups/access_log}} - Lists all cupsd http1.1 server activity
+
# lprm - # remove all entries
  
Of course, it is important to know how CUPS works if wanting to solve related issues:
+
=== Web interface ===
# 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.
+
The CUPS server can be fully administered through the web interface, available on http://localhost:631/.
  
===Problems resulting from upgrades===
+
{{Note|If an HTTPS connection to CUPS is used, it ''may'' take a very long time before the interface appears the first time the it is accessed. This is because the first request triggers the generation of SSL certificates which can be a time-consuming job.}}
''Issues that appeared after CUPS and related program packages underwent a version increment''
+
  
====CUPS stops working====
+
;Add a queue
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.
+
Go to the '''Administration''' page.  
  
To use the new configuration, copy /etc/cups/cupsd.conf.default to /etc/cups/cupsd.conf (backup the old configuration if needed):
+
;Modify existing queues
# cp /etc/cups/cupsd.conf.default /etc/cups/cupsd.conf
+
Go to the '''Printers''' page, and select a queue to modify.
and restart CUPS to employ the new settings.
+
  
====All jobs are "stopped"====
+
;Test a queue
If all jobs sent to the printer become "stopped", delete the printer and add it again.
+
Go to the '''Printers''' page, and select a queue.
Using the [http://localhost:631 CUPS web interface], go to Printers > Delete Printer.
+
  
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.
+
=== GUI applications ===
  
====All jobs are "The printer is not responding"====
+
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]].
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
+
* {{App|print-manager|A tool for managing print jobs and printers ([[KDE]]).|https://projects.kde.org/projects/kde/kdeutils/print-manager|{{Pkg|print-manager}}}}
 +
* {{App|system-config-printer|A CUPS printer configuration tool and status applet ([[GNOME]] and others)|http://cyberelk.net/tim/software/system-config-printer/|{{Pkg|system-config-printer}}}}
 +
* {{App|gtklp|GTK+ interface to CUPS.|http://gtklp.sirtobi.com/index.shtml|{{AUR|gtklp}}}}
  
====The PPD version is not compatible with gutenprint====
+
== Configuration ==
Run:
+
# /usr/sbin/cups-genppdupdate
+
  
And restart CUPS (as pointed out in gutenprint's post-install message)
+
The CUPS server configuration is located in {{ic|/etc/cups/cupsd.conf}} and {{ic|/etc/cups/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.
  
===USB printers under CUPS 1.4.x===
+
[[Groups]] with printer administration privileges are defined in {{ic|SystemGroup}} in the {{ic|/etc/cups/cups-files.conf}}. The {{ic|sys}} group is used by default.
New CUPS 1.4.x introduces many changes:
+
  
====Device node permissions====
+
{{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}}.
Some device may not be set with proper permission, especially 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.
+
$ 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:
+
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.
# hplip and cups 1.4+ use raw USB devices, so permissions should be similar to
+
# the ones from the old usblp kernel module
+
SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ENV{ID_USB_INTERFACES}=="", IMPORT{program}="usb_id --export %p"
+
SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ENV{ID_USB_INTERFACES}==":0701*:", GROUP="lp", MODE="660"
+
  
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.
+
=== cups-browsed ===
  
=====Device node permission troubleshooting=====
+
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}}. Note that jobs are sent directly to the printer without any processing so the created queues may not work.
Get the printer's device file and its permissions with:
+
$ 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.
+
=== Printer sharing ===
cat /etc/udev/rules.d/10-usbprinter.rules
+
ATTR{idVendor}=="04b8", ATTR{idProduct}=="0841", MODE:="0660", GROUP:="lp"
+
  
If you have a multifunction device (printer+scanner) you need to make the device detectable to sane too
+
See [[CUPS/Printer sharing]].
cat /etc/udev/rules.d/10-usbprinter.rules
+
ATTR{idVendor}=="04b8", ATTR{idProduct}=="0841", MODE:="0660", GROUP:="lp", ENV{libsane_matched}:="yes"
+
  
{{Note|
+
=== Without a local CUPS server ===
* {{ic|idVendor}} and {{ic|idProduct}} are from the {{ic|lsusb}} listing above.
+
* some printers will need permissions to be {{ic|666}}
+
* on my machine the propper folder is {{ic|/usr/lib/udev/rules.d}}
+
}}
+
  
=====Loading firmware=====
+
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.
  
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.
+
{{Warning|Accessing remote printers without a local CUPS server is not recommended by the developers.[http://www.cups.org/pipermail/cups/2015-October/027229.html]}}
  
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.
+
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):
  
Locate the line matching your printer in /etc/udev/rules.d/11-hpj10xx.rules:
+
  $ CUPS_SERVER=printserver.mydomain:port firefox
  ACTION=="add", KERNEL=="lp*", SUBSYSTEM=="usb", ATTRS{idVendor}=="03f0",    \
+
        ATTRS{idProduct}=="4117", RUN+="/sbin/foo2zjs-loadfw 1018 $tempnode"
+
Add the following lines below it, make sure match the product and vendor IDs:
+
ACTION=="add", KERNEL=="lp*", SUBSYSTEM=="usb", ATTRS{idVendor}=="03f0",    \
+
        ATTRS{idProduct}=="4117", RUN+="/usr/bin/sleep 15"
+
ACTION=="add", KERNEL=="lp*", SUBSYSTEM=="usb", ATTRS{idVendor}=="03f0",    \
+
        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!!!
+
==== client.conf ====
  
===Other===
+
{{Note|1={{ic|/etc/cups/client.conf}} is [https://www.cups.org/doc/man-client.conf.html deprecated], it is removed in [https://git.archlinux.org/svntogit/packages.git/commit/trunk?h=packages/cups&id=41fefa22ac5189d726e0e35e2f87ad12fa2855f3 cups 2.2.0]}}
  
=====CUPS permission errors=====
+
An alternative, deprecated method, involves editing {{ic|/etc/cups/client.conf}} and setting the {{ic|ServerName}} directive:
*Some users fixed 'NT_STATUS_ACCESS_DENIED' (Windows clients) errors by using a slightly different syntax:
+
smb://workgroup/username:password@hostname/printer_name
+
  
*Sometimes, the block device has wrong permissions:
+
{{hc|/etc/cups/client.conf|
# ls /dev/usb/
+
# (Substitute printserver.mydomain with your print server name)
lp0
+
ServerName printserver.mydomain
# chgrp lp /dev/usb/lp0
+
}}
 
+
====HPLIP printer sends "/usr/lib/cups/backend/hp failed" error====
+
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.
+
 
+
Try adding the printer as a Network Printer using the http:// protocol. Generate the printer URI with {{ic|hp-makeuri}}.
+
 
+
{{Note|There might need to set permissions issues right. Follow indications here: [[CUPS#Device_node_permissions]].}}
+
 
+
====HPLIP printer claims job is complete but printer does nothing====
+
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.
+
 
+
Some hp printers (e.g hp Laserjet) require their firmware to be downloaded from the computer every time the printer is switched on. If there is an issue with udev (or equivalent) and the firmware download rule is never fired, you may experience this issue.
+
As a workaround, you can manually download the firmware to the printer. Ensure the printer is plugged in and switched on, then enter
+
hp-firmware -n
+
 
+
====hp-toolbox sends an error, "Unable to communicate with device"====
+
If running hp-toolbox as a regular user results in:
+
# 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).
+
 
+
This can also occur with network attached printers if the [[Avahi|avahi-daemon]] is not running.
+
 
+
====CUPS returns '"foomatic-rip" not available/stopped with status 3' with a HP printer====
+
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':
+
Filter "foomatic-rip" for printer "<printer_name>" not available: No such file or director
+
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 [https://bbs.archlinux.org/viewtopic.php?id=65615 this forum post].
+
# pacman -S hplip
+
 
+
====Printing fails with unauthorised error====
+
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.
+
 
+
====Print button greyed-out in GNOME print dialogs====
+
:''<small>Source: [https://bbs.archlinux.org/viewtopic.php?id=70418 I can't print from gnome applications. - Arch Forums]</small>''
+
 
+
Be sure the package: '''libgnomeprint''' is installed
+
 
+
Edit {{ic|/etc/cups/cupsd.conf}} and add
+
# HostNameLookups Double
+
 
+
Restart CUPS:
+
# systemctl restart cups
+
 
+
====Unknown supported format: application/postscript====
+
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====
+
 
+
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:
+
$ smbtree -U ''windowsusername''
+
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:
+
{{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.
+
 
+
====lp: Error - Scheduler Not Responding====
+
If you get this error when printing a document using:
+
 
+
$ lp document-to-print
+
 
+
Try setting the CUPS_SERVER environment variable:
+
 
+
$ export CUPS_SERVER=localhost
+
 
+
If this solves your problem, make the solution permanent by adding the export line above to ~/.bash_profile.
+
 
+
====Installed Printers Do Not Appear in Print Dialogs After Installing/Upgrading to Systemd====
+
Systemd uses a different cups socket file located at:
+
 
+
'''/usr/lib/systemd/system/cups.socket'''
+
 
+
The default cups socket file is located at:
+
 
+
'''/var/run/cups/cups.sock'''
+
 
+
Edit '''/etc/cups/cupsd.conf''' and '''/etc/cups/client.conf''' as root to use the Systemd socket instead of the default.  Make sure to restart CUPS when you are done:
+
 
+
# systemctl restart cups
+
 
+
 
+
====CUPS prints only an empty and an error-message page on HP LaserJet====
+
 
+
There is a bug that causes CUPS to fail when printing images on HP LaserJet (in my case 3380). The bug has been reported and fixed by [https://bugs.launchpad.net/ubuntu/+source/cups-filters/+bug/998087 Ubuntu].
+
The first page is empty, the second page contains the following error message:
+
  ERROR:
+
  invalidaccess
+
  OFFENDING COMMAND:
+
  filter
+
  STACK:
+
  /SubFileDecode
+
  endstream
+
  ...
+
 
+
In order to fix the issue, use the following command (as superuser):
+
  lpadmin -p <printer> -o pdftops-renderer-default=pdftops
+
 
+
==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}}
+
SystemGroup sys root <insert here>
+
 
+
* 3. Restart cups, log out and in again (or restart computer)
+
{{bc|# systemctl restart cups}}
+
 
+
[[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.
+
 
+
There is also [https://aur.archlinux.org/packages.php?ID=43505 gtklp] in the [[AUR]]
+
 
+
===PDF virtual printer===
+
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
+
#Out /var/spool/cups-pdf/${USER}
+
 
+
to
+
 
+
Out /home/${USER}
+
 
+
This package can be installed by the following command:
+
# 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].
+
 
+
==== Print to postscript: CUPS-PDF virtual printer trick ====
+
  
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".
+
The remote system's default printer setting will be used by default.
  
=====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]
* [https://bbs.archlinux.org/ Arch Linux User Forums]
+
* [https://wiki.gentoo.org/wiki/Printing Gentoo's printing guide]
* [http://wiki.gotux.net/tutorials/software/hp-printer Install HP Printers Easy Way]
+

Latest revision as of 07:44, 23 September 2016

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/$USER. The location can be changed in /etc/cups/cups-pdf.conf.

Start and enable org.cups.cupsd.service.

Connection Interfaces

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

Note: CUPS helper programs are run using the lp group and daemon user. This allows the helper programs to access printer devices and read config files in /etc/cups/, which all belong to the lp group. This default may conflict with non-printer parallel port device access:
  • Adding extra users to the lp group will allow those users to read CUPS files, and
  • CUPS helpers may gain access to any non-printer parallel port devices.
If this is a concern, consider using a Udev rule to assign a different group for any non-printer parallel port device (FS#50009). The group and user that CUPS uses can be changed, but the permissions of some files may need to be manually fixed.

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 use Avahi hostnames to connect to networked printers, set up .local hostname resolution and restart org.cups.cupsd.service.

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, install the samba package.

Printer Drivers

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 provides a few PPDs and filter binaries by default, which should work out of the box.

Foomatic

The foomatic project 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 foomatic-db-ppds, foomatic-db-nonfree-ppds, or foomatic-db-gutenprint-ppds.

The foomatic PPDs may require additional filters, such as gutenprint, ghostscript, or another source (for instance min12xxwAUR). For ghostscript, gsfonts may also be required.

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.

USB

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

If it doesn't, 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 [2]. As exact details of the URIs differ between printers, check either the manual of the printer or CUPS/Printer-specific problems.

Remote CUPS print servers can be accessed through a URI of the form ipp://hostname:631/printers/queue_name. See CUPS/Printer sharing#Between GNU/Linux systems 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, [3]). See #Usage for an example of setting a print queue to 'raw'.

Usage

CUPS can be fully controlled using the lp* and cups* command-line 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 printer. A common use is the 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
List the devices
# lpinfo -v # 
$ /usr/lib/cups/backend/snmp ip_address # Use SNMP to find a URI
List the drivers
$ lpinfo -m
Add a new queue
# lpadmin -p queue_name -E -v uri -m model

The queue_name is up to you. Example:

# lpadmin -p HP_DESKJET_940C -E -v "usb://HP/DESKJET%20940C?serial=CN16E6C364BH" -m drv:///HP/hp-deskjet_940c.ppd.gz
# lpadmin -p SHARED_PRINTER -m raw    # Raw queue; no PPD or filter
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 the it is accessed. This is because the first request triggers the generation of SSL certificates which can be a time-consuming job.
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.

  • print-manager — A tool for managing print jobs and printers (KDE).
https://projects.kde.org/projects/kde/kdeutils/print-manager || print-manager
  • system-config-printer — A CUPS printer configuration tool and status applet (GNOME and others)
http://cyberelk.net/tim/software/system-config-printer/ || system-config-printer
  • gtklp — GTK+ interface to CUPS.
http://gtklp.sirtobi.com/index.shtml || gtklpAUR

Configuration

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

Groups with printer administration privileges are defined in SystemGroup in the /etc/cups/cups-files.conf. The sys group is 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

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. Note that jobs are sent directly to the printer without any processing so the created queues may not work.

Printer sharing

See CUPS/Printer sharing.

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.[4]

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

client.conf

Note: /etc/cups/client.conf is deprecated, it is removed in cups 2.2.0

An alternative, deprecated method, involves editing /etc/cups/client.conf and setting the ServerName directive:

/etc/cups/client.conf
# (Substitute printserver.mydomain with your print server name)
ServerName printserver.mydomain

The remote system's default printer setting will be used by default.

Troubleshooting

See CUPS/Troubleshooting.

See also