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