]>
Commit | Line | Data |
---|---|---|
f8e23ef7 MS |
1 | README - CUPS v1.7.0 - 2013-07-16 |
2 | --------------------------------- | |
0cb67df3 MS |
3 | |
4 | Looking for compile instructions? Read the file "INSTALL.txt" instead... | |
ef416fc2 | 5 | |
ef416fc2 | 6 | |
7 | INTRODUCTION | |
8 | ||
b0f6947b | 9 | CUPS is a standards-based, open source printing system developed by Apple |
37e7e6e0 | 10 | Inc. for OS® X and other UNIX®-like operating systems. CUPS uses the |
b0f6947b MS |
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! | |
ef416fc2 | 16 | |
557dde9f MS |
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. | |
ef416fc2 | 23 | |
557dde9f MS |
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 | |
26 | information. | |
ef416fc2 | 27 | |
28 | ||
29 | READING THE DOCUMENTATION | |
30 | ||
557dde9f MS |
31 | Once you have installed the software you can access the documentation (and |
32 | a bunch of other stuff) online at: | |
ef416fc2 | 33 | |
4744bd90 | 34 | http://localhost:631/ |
ef416fc2 | 35 | |
557dde9f MS |
36 | If you're having trouble getting that far, the documentation is located |
37 | under the "doc/help" directory. | |
ef416fc2 | 38 | |
4744bd90 | 39 | Please read the documentation before asking questions. |
ef416fc2 | 40 | |
41 | ||
42 | GETTING SUPPORT AND OTHER RESOURCES | |
43 | ||
557dde9f MS |
44 | If you have problems, READ THE DOCUMENTATION FIRST! We also provide many |
45 | discussion forums which are available at: | |
ef416fc2 | 46 | |
4744bd90 | 47 | http://www.cups.org/newsgroups.php |
ef416fc2 | 48 | |
557dde9f | 49 | See the CUPS web site at "http://www.cups.org/" for other resources. |
ef416fc2 | 50 | |
51 | ||
52 | SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER | |
53 | ||
557dde9f MS |
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: | |
ef416fc2 | 57 | |
4744bd90 | 58 | http://localhost:631/admin/ |
ef416fc2 | 59 | |
557dde9f MS |
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 | |
63 | Settings" button. | |
ef416fc2 | 64 | |
557dde9f MS |
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. | |
ef416fc2 | 68 | |
69 | ||
70 | SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE | |
71 | ||
557dde9f MS |
72 | CUPS works best with PPD (PostScript Printer Description) files. In a pinch |
73 | you can also use System V style printer interface scripts. | |
ef416fc2 | 74 | |
4744bd90 | 75 | CUPS includes several sample PPD files you can use: |
ef416fc2 | 76 | |
557dde9f | 77 | Driver PPD Name |
61cf44e2 MS |
78 | ----------------------------- ------------------------------ |
79 | Dymo Label Printers drv:///sample.drv/dymo.ppd | |
80 | Intellitech Intellibar drv:///sample.drv/intelbar.ppd | |
81 | EPSON Stylus Color Series drv:///sample.drv/stcolor.ppd | |
82 | EPSON Stylus Photo Series drv:///sample.drv/stphoto.ppd | |
83 | EPSON Stylus New Color Series drv:///sample.drv/stcolor2.ppd | |
84 | EPSON Stylus New Photo Series drv:///sample.drv/stphoto2.ppd | |
85 | EPSON 9-pin Series drv:///sample.drv/epson9.ppd | |
86 | EPSON 24-pin Series drv:///sample.drv/epson24.ppd | |
557dde9f MS |
87 | Generic PCL Laser Printer drv:///sample.drv/generpcl.ppd |
88 | Generic PostScript Printer drv:///sample.drv/generic.ppd | |
61cf44e2 MS |
89 | HP DeskJet Series drv:///sample.drv/deskjet.ppd |
90 | HP LaserJet Series drv:///sample.drv/laserjet.ppd | |
91 | OKIDATA 9-Pin Series drv:///sample.drv/okidata9.ppd | |
92 | OKIDATA 24-Pin Series drv:///sample.drv/okidat24.ppd | |
93 | Zebra CPCL Label Printer drv:///sample.drv/zebracpl.ppd | |
94 | Zebra EPL1 Label Printer drv:///sample.drv/zebraep1.ppd | |
95 | Zebra EPL2 Label Printer drv:///sample.drv/zebraep2.ppd | |
96 | Zebra ZPL Label Printer drv:///sample.drv/zebra.ppd | |
97 | ||
98 | Run the "lpinfo -m" command to list the available drivers: | |
99 | ||
100 | lpinfo -m | |
101 | ||
102 | Run the "lpinfo -v" command to list the available printers: | |
ef416fc2 | 103 | |
4744bd90 | 104 | lpinfo -v |
ef416fc2 | 105 | |
557dde9f | 106 | Then use the correct URI to add the printer using the "lpadmin" command: |
ef416fc2 | 107 | |
557dde9f | 108 | lpadmin -p printername -E -v device-uri -m ppd-name |
ef416fc2 | 109 | |
4744bd90 | 110 | Network printers typically use "socket" or "lpd" URIs: |
ef416fc2 | 111 | |
557dde9f MS |
112 | lpadmin -p printername -E -v socket://11.22.33.44 -m ppd-name |
113 | lpadmin -p printername -E -v lpd://11.22.33.44/ -m ppd-name | |
114 | ||
115 | The sample drivers provide basic printing capabilities, but generally do not | |
116 | exercise the full potential of the printers or CUPS. The CUPS web site | |
117 | provides links and drivers: | |
ef416fc2 | 118 | |
557dde9f MS |
119 | http://www.cups.org/ppd.php PPD files |
120 | http://www.cups.org/links.php Links to other drivers | |
ef416fc2 | 121 | |
122 | ||
123 | PRINTING FILES | |
124 | ||
557dde9f MS |
125 | CUPS provides both the System V "lp" and Berkeley "lpr" commands for |
126 | printing: | |
ef416fc2 | 127 | |
4744bd90 | 128 | lp filename |
129 | lpr filename | |
ef416fc2 | 130 | |
557dde9f | 131 | Both the "lp" and "lpr" commands support printing options for the driver: |
ef416fc2 | 132 | |
557dde9f MS |
133 | lp -o media=A4 -o resolution=600dpi filename |
134 | lpr -o media=A4 -o resolution=600dpi filename | |
ef416fc2 | 135 | |
557dde9f MS |
136 | CUPS recognizes many types of images files as well as PDF, PostScript, |
137 | HP-GL/2, and text files, so you can print those files directly rather than | |
138 | through an application. | |
ef416fc2 | 139 | |
557dde9f MS |
140 | If you have an application that generates output specifically for your |
141 | printer then you need to use the "-oraw" or "-l" options: | |
ef416fc2 | 142 | |
557dde9f | 143 | lp -o raw filename |
4744bd90 | 144 | lpr -l filename |
ef416fc2 | 145 | |
4744bd90 | 146 | This will prevent the filters from misinterpreting your print |
147 | file. | |
ef416fc2 | 148 | |
149 | ||
150 | LEGAL STUFF | |
151 | ||
0fa6c7fa | 152 | CUPS is Copyright 2007-2013 by Apple Inc. CUPS and the CUPS logo are |
d7871c8c | 153 | trademarks of Apple Inc. |
ef416fc2 | 154 | |
4744bd90 | 155 | The MD5 Digest code is Copyright 1999 Aladdin Enterprises. |
ef416fc2 | 156 | |
557dde9f | 157 | This software is based in part on the work of the Independent JPEG Group. |
ef416fc2 | 158 | |
557dde9f MS |
159 | CUPS is provided under the terms of version 2 of the GNU General Public |
160 | License and GNU Library General Public License. This program is distributed | |
161 | in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even | |
162 | the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
163 | See the "doc/help/license.html" or "LICENSE.txt" files for more information. |