1 README - CUPS v2.2.5 - 2017-10-12
2 =================================
4 Looking for compile instructions? Read the file `INSTALL.md` instead...
11 CUPS is a standards-based, open source printing system developed by Apple Inc.
12 for macOS® and other UNIX®-like operating systems. CUPS uses the Internet
13 Printing Protocol ("IPP") and provides System V and Berkeley command-line
14 interfaces, a web interface, and a C API to manage printers and print jobs. It
15 supports printing to both local (parallel, serial, USB) and networked printers,
16 and printers can be shared from one computer to another, even over the Internet!
18 Internally, CUPS uses PostScript Printer Description ("PPD") files to describe
19 printer capabilities and features and a wide variety of generic and device-
20 specific programs to convert and print many types of files. Sample drivers are
21 included with CUPS to support many Dymo, EPSON, HP, Intellitech, OKIDATA, and
22 Zebra printers. Many more drivers are available online and (in some cases) on
23 the driver CD-ROM that came with your printer.
25 CUPS is licensed under the GNU General Public License and GNU Library General
26 Public License versions 2. See the file "LICENSE.txt" for more information.
29 READING THE DOCUMENTATION
30 -------------------------
32 Once you have installed the software you can access the documentation (and a
33 bunch of other stuff) online at:
37 If you're having trouble getting that far, the documentation is located under
38 the `doc/help` directory.
40 Please read the documentation before asking questions.
43 GETTING SUPPORT AND OTHER RESOURCES
44 -----------------------------------
46 If you have problems, **read the documentation first!** We also provide two mailing
47 lists which are available at:
49 https://lists.cups.org/mailman/listinfo
51 See the CUPS web site at <https://www.cups.org/> for other resources.
54 SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER
55 ------------------------------------------------
57 CUPS includes a web-based administration tool that allows you to manage
58 printers, classes, and jobs on your server. Open the following URL in your
59 browser to access the printer administration tools:
61 http://localhost:631/admin/
63 *Do not* use the hostname for your machine - it will not work with the default
64 CUPS configuration. To enable administration access on other addresses, check
65 the `Allow Remote Administration` box and click on the `Change Settings button.
67 You will be asked for the administration password (root or any other user in the
68 `sys/system/root/admin/lpadmin` group on your system) when performing any
69 administrative function.
72 SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE
73 -----------------------------------------------
75 CUPS works best with PPD (PostScript Printer Description) files. In a pinch you
76 can also use System V style printer interface scripts.
78 CUPS includes several sample PPD files you can use:
81 ----------------------------- ------------------------------
82 Dymo Label Printers drv:///sample.drv/dymo.ppd
83 Intellitech Intellibar drv:///sample.drv/intelbar.ppd
84 EPSON 9-pin Series drv:///sample.drv/epson9.ppd
85 EPSON 24-pin Series drv:///sample.drv/epson24.ppd
86 Generic PCL Laser Printer drv:///sample.drv/generpcl.ppd
87 Generic PostScript Printer drv:///sample.drv/generic.ppd
88 HP DeskJet Series drv:///sample.drv/deskjet.ppd
89 HP LaserJet Series drv:///sample.drv/laserjet.ppd
90 OKIDATA 9-Pin Series drv:///sample.drv/okidata9.ppd
91 OKIDATA 24-Pin Series drv:///sample.drv/okidat24.ppd
92 Zebra CPCL Label Printer drv:///sample.drv/zebracpl.ppd
93 Zebra EPL1 Label Printer drv:///sample.drv/zebraep1.ppd
94 Zebra EPL2 Label Printer drv:///sample.drv/zebraep2.ppd
95 Zebra ZPL Label Printer drv:///sample.drv/zebra.ppd
97 Run the `lpinfo -m` command to list the available drivers:
101 Run the `lpinfo -v` command to list the available printers:
105 Then use the correct URI to add the printer using the `lpadmin` command:
107 lpadmin -p printername -E -v device-uri -m ppd-name
109 Network printers typically use `socket` or `lpd` URIs:
111 lpadmin -p printername -E -v socket://11.22.33.44 -m ppd-name
112 lpadmin -p printername -E -v lpd://11.22.33.44/ -m ppd-name
114 The sample drivers provide basic printing capabilities, but generally do not
115 exercise the full potential of the printers or CUPS.
117 CUPS also supports IPP Everywhere printers using the "everywhere" model, for
120 lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere
126 CUPS provides both the System V `lp` and Berkeley `lpr` commands for printing:
131 Both the `lp` and `lpr` commands support printing options for the driver:
133 lp -o media=A4 -o resolution=600dpi filename
134 lpr -o media=A4 -o resolution=600dpi filename
136 CUPS recognizes many types of images files as well as PDF, PostScript, and text
137 files, so you can print those files directly rather than through an application.
139 If you have an application that generates output specifically for your printer
140 then you need to use the `-oraw` or `-l` options:
145 This will prevent the filters from misinterpreting your print file.
151 CUPS is copyright © 2007-2017 by Apple Inc. CUPS and the CUPS logo are
152 trademarks of Apple Inc.
154 The MD5 Digest code is Copyright 1999 Aladdin Enterprises.
156 CUPS is provided under the terms of version 2 of the GNU General Public License
157 and GNU Library General Public License. This program is distributed in the hope
158 that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
159 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
160 "doc/help/license.html" or "LICENSE.txt" files for more information.