]>
Commit | Line | Data |
---|---|---|
0ad6ac55 | 1 | README - CUPS v2.2.13 - 2019-12-13 |
25b23383 | 2 | ================================== |
2a20b512 | 3 | |
16389be3 | 4 | Looking for compile instructions? Read the file `INSTALL.md` instead... |
2a20b512 MS |
5 | |
6 | ||
7 | INTRODUCTION | |
8 | ------------ | |
9 | ||
10 | ||
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! | |
17 | ||
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. | |
24 | ||
c8cb6400 MS |
25 | CUPS 2.2.x is licensed under the GNU General Public License and GNU Library |
26 | General Public License versions 2. See the file "LICENSE.txt" for more | |
27 | information. | |
2a20b512 MS |
28 | |
29 | ||
30 | READING THE DOCUMENTATION | |
31 | ------------------------- | |
32 | ||
33 | Once you have installed the software you can access the documentation (and a | |
a7cdcd19 | 34 | bunch of other stuff) online at <http://localhost:631/>. |
2a20b512 MS |
35 | |
36 | If you're having trouble getting that far, the documentation is located under | |
a7cdcd19 | 37 | the `doc/help` and `man` directories. |
2a20b512 MS |
38 | |
39 | Please read the documentation before asking questions. | |
40 | ||
41 | ||
42 | GETTING SUPPORT AND OTHER RESOURCES | |
43 | ----------------------------------- | |
44 | ||
a7cdcd19 MS |
45 | If you have problems, *read the documentation first!* We also provide two |
46 | mailing lists which are available at <https://lists.cups.org/mailman/listinfo>. | |
2a20b512 MS |
47 | |
48 | See the CUPS web site at <https://www.cups.org/> for other resources. | |
49 | ||
50 | ||
51 | SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER | |
52 | ------------------------------------------------ | |
53 | ||
54 | CUPS includes a web-based administration tool that allows you to manage | |
a7cdcd19 MS |
55 | printers, classes, and jobs on your server. Open <http://localhost:631/admin/> |
56 | in your browser to access the printer administration tools: | |
2a20b512 MS |
57 | |
58 | *Do not* use the hostname for your machine - it will not work with the default | |
59 | CUPS configuration. To enable administration access on other addresses, check | |
16389be3 | 60 | the `Allow Remote Administration` box and click on the `Change Settings button. |
2a20b512 MS |
61 | |
62 | You will be asked for the administration password (root or any other user in the | |
a7cdcd19 | 63 | sys/system/root/admin/lpadmin group on your system) when performing any |
2a20b512 MS |
64 | administrative function. |
65 | ||
66 | ||
67 | SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE | |
68 | ----------------------------------------------- | |
69 | ||
a7cdcd19 MS |
70 | CUPS currently uses PPD (PostScript Printer Description) files that describe |
71 | printer capabilities and driver programs needed for each printer. The | |
72 | `everywhere` PPD is used for nearly all modern networks printers sold since | |
73 | about 2009. For example, the following command creates a print queue for a | |
74 | printer at address 11.22.33.44: | |
2a20b512 | 75 | |
a7cdcd19 MS |
76 | lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere |
77 | ||
78 | CUPS also includes several sample PPD files you can use for "legacy" printers: | |
2a20b512 MS |
79 | |
80 | Driver PPD Name | |
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 | |
96 | ||
a7cdcd19 | 97 | You can run the `lpinfo -m` command to list all of the available drivers: |
2a20b512 MS |
98 | |
99 | lpinfo -m | |
100 | ||
16389be3 | 101 | Run the `lpinfo -v` command to list the available printers: |
2a20b512 MS |
102 | |
103 | lpinfo -v | |
104 | ||
16389be3 | 105 | Then use the correct URI to add the printer using the `lpadmin` command: |
2a20b512 MS |
106 | |
107 | lpadmin -p printername -E -v device-uri -m ppd-name | |
108 | ||
a7cdcd19 MS |
109 | Current network printers typically use `ipp` or `ipps` URIS: |
110 | ||
111 | lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere | |
112 | lpadmin -p printername -E -v ipps://11.22.33.44/ipp/print -m everywhere | |
113 | ||
114 | Older network printers typically use `socket` or `lpd` URIs: | |
2a20b512 MS |
115 | |
116 | lpadmin -p printername -E -v socket://11.22.33.44 -m ppd-name | |
117 | lpadmin -p printername -E -v lpd://11.22.33.44/ -m ppd-name | |
118 | ||
119 | The sample drivers provide basic printing capabilities, but generally do not | |
a7cdcd19 MS |
120 | exercise the full potential of the printers or CUPS. Other drivers provide |
121 | greater printing capabilities. | |
2a20b512 MS |
122 | |
123 | ||
124 | PRINTING FILES | |
125 | -------------- | |
126 | ||
16389be3 | 127 | CUPS provides both the System V `lp` and Berkeley `lpr` commands for printing: |
2a20b512 MS |
128 | |
129 | lp filename | |
130 | lpr filename | |
131 | ||
16389be3 | 132 | Both the `lp` and `lpr` commands support printing options for the driver: |
2a20b512 MS |
133 | |
134 | lp -o media=A4 -o resolution=600dpi filename | |
135 | lpr -o media=A4 -o resolution=600dpi filename | |
136 | ||
137 | CUPS recognizes many types of images files as well as PDF, PostScript, and text | |
138 | files, so you can print those files directly rather than through an application. | |
139 | ||
140 | If you have an application that generates output specifically for your printer | |
16389be3 | 141 | then you need to use the `-oraw` or `-l` options: |
2a20b512 MS |
142 | |
143 | lp -o raw filename | |
144 | lpr -l filename | |
145 | ||
146 | This will prevent the filters from misinterpreting your print file. | |
147 | ||
148 | ||
149 | LEGAL STUFF | |
150 | ----------- | |
151 | ||
e4a0aa86 | 152 | CUPS is copyright © 2007-2019 by Apple Inc. CUPS and the CUPS logo are |
2a20b512 MS |
153 | trademarks of Apple Inc. |
154 | ||
155 | The MD5 Digest code is Copyright 1999 Aladdin Enterprises. | |
156 | ||
157 | CUPS is provided under the terms of version 2 of the GNU General Public License | |
158 | and GNU Library General Public License. This program is distributed in the hope | |
159 | that it will be useful, but WITHOUT ANY WARRANTY; without even the implied | |
160 | warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
a7cdcd19 | 161 | `doc/help/license.html` or `LICENSE.txt` files for more information. |