]>
Commit | Line | Data |
---|---|---|
464f939e | 1 | README - CUPS v2.3b5 - 2018-06-05 |
63f8dcbd | 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 | ||
e944dbd4 MS |
25 | CUPS is licensed under the Apache License Version 2.0. See the file |
26 | "LICENSE" for more information. | |
2a20b512 MS |
27 | |
28 | ||
29 | READING THE DOCUMENTATION | |
30 | ------------------------- | |
31 | ||
32 | Once you have installed the software you can access the documentation (and a | |
a7cdcd19 | 33 | bunch of other stuff) online at <http://localhost:631/>. |
2a20b512 MS |
34 | |
35 | If you're having trouble getting that far, the documentation is located under | |
a7cdcd19 | 36 | the `doc/help` and `man` directories. |
2a20b512 MS |
37 | |
38 | Please read the documentation before asking questions. | |
39 | ||
40 | ||
41 | GETTING SUPPORT AND OTHER RESOURCES | |
42 | ----------------------------------- | |
43 | ||
a7cdcd19 MS |
44 | If you have problems, *read the documentation first!* We also provide two |
45 | mailing lists which are available at <https://lists.cups.org/mailman/listinfo>. | |
2a20b512 MS |
46 | |
47 | See the CUPS web site at <https://www.cups.org/> for other resources. | |
48 | ||
49 | ||
50 | SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER | |
51 | ------------------------------------------------ | |
52 | ||
53 | CUPS includes a web-based administration tool that allows you to manage | |
a7cdcd19 MS |
54 | printers, classes, and jobs on your server. Open <http://localhost:631/admin/> |
55 | in your browser to access the printer administration tools: | |
2a20b512 MS |
56 | |
57 | *Do not* use the hostname for your machine - it will not work with the default | |
58 | CUPS configuration. To enable administration access on other addresses, check | |
16389be3 | 59 | the `Allow Remote Administration` box and click on the `Change Settings button. |
2a20b512 MS |
60 | |
61 | You will be asked for the administration password (root or any other user in the | |
a7cdcd19 | 62 | sys/system/root/admin/lpadmin group on your system) when performing any |
2a20b512 MS |
63 | administrative function. |
64 | ||
65 | ||
66 | SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE | |
67 | ----------------------------------------------- | |
68 | ||
a7cdcd19 MS |
69 | CUPS currently uses PPD (PostScript Printer Description) files that describe |
70 | printer capabilities and driver programs needed for each printer. The | |
71 | `everywhere` PPD is used for nearly all modern networks printers sold since | |
72 | about 2009. For example, the following command creates a print queue for a | |
73 | printer at address 11.22.33.44: | |
2a20b512 | 74 | |
a7cdcd19 MS |
75 | lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere |
76 | ||
77 | CUPS also includes several sample PPD files you can use for "legacy" printers: | |
2a20b512 MS |
78 | |
79 | Driver PPD Name | |
80 | ----------------------------- ------------------------------ | |
81 | Dymo Label Printers drv:///sample.drv/dymo.ppd | |
82 | Intellitech Intellibar drv:///sample.drv/intelbar.ppd | |
83 | EPSON 9-pin Series drv:///sample.drv/epson9.ppd | |
84 | EPSON 24-pin Series drv:///sample.drv/epson24.ppd | |
85 | Generic PCL Laser Printer drv:///sample.drv/generpcl.ppd | |
86 | Generic PostScript Printer drv:///sample.drv/generic.ppd | |
87 | HP DeskJet Series drv:///sample.drv/deskjet.ppd | |
88 | HP LaserJet Series drv:///sample.drv/laserjet.ppd | |
89 | OKIDATA 9-Pin Series drv:///sample.drv/okidata9.ppd | |
90 | OKIDATA 24-Pin Series drv:///sample.drv/okidat24.ppd | |
91 | Zebra CPCL Label Printer drv:///sample.drv/zebracpl.ppd | |
92 | Zebra EPL1 Label Printer drv:///sample.drv/zebraep1.ppd | |
93 | Zebra EPL2 Label Printer drv:///sample.drv/zebraep2.ppd | |
94 | Zebra ZPL Label Printer drv:///sample.drv/zebra.ppd | |
95 | ||
a7cdcd19 | 96 | You can run the `lpinfo -m` command to list all of the available drivers: |
2a20b512 MS |
97 | |
98 | lpinfo -m | |
99 | ||
16389be3 | 100 | Run the `lpinfo -v` command to list the available printers: |
2a20b512 MS |
101 | |
102 | lpinfo -v | |
103 | ||
16389be3 | 104 | Then use the correct URI to add the printer using the `lpadmin` command: |
2a20b512 MS |
105 | |
106 | lpadmin -p printername -E -v device-uri -m ppd-name | |
107 | ||
a7cdcd19 MS |
108 | Current network printers typically use `ipp` or `ipps` URIS: |
109 | ||
110 | lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere | |
111 | lpadmin -p printername -E -v ipps://11.22.33.44/ipp/print -m everywhere | |
112 | ||
113 | Older network printers typically use `socket` or `lpd` URIs: | |
2a20b512 MS |
114 | |
115 | lpadmin -p printername -E -v socket://11.22.33.44 -m ppd-name | |
116 | lpadmin -p printername -E -v lpd://11.22.33.44/ -m ppd-name | |
117 | ||
118 | The sample drivers provide basic printing capabilities, but generally do not | |
a7cdcd19 MS |
119 | exercise the full potential of the printers or CUPS. Other drivers provide |
120 | greater printing capabilities. | |
2a20b512 MS |
121 | |
122 | ||
123 | PRINTING FILES | |
124 | -------------- | |
125 | ||
16389be3 | 126 | CUPS provides both the System V `lp` and Berkeley `lpr` commands for printing: |
2a20b512 MS |
127 | |
128 | lp filename | |
129 | lpr filename | |
130 | ||
16389be3 | 131 | Both the `lp` and `lpr` commands support printing options for the driver: |
2a20b512 MS |
132 | |
133 | lp -o media=A4 -o resolution=600dpi filename | |
134 | lpr -o media=A4 -o resolution=600dpi filename | |
135 | ||
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. | |
138 | ||
139 | If you have an application that generates output specifically for your printer | |
16389be3 | 140 | then you need to use the `-oraw` or `-l` options: |
2a20b512 MS |
141 | |
142 | lp -o raw filename | |
143 | lpr -l filename | |
144 | ||
145 | This will prevent the filters from misinterpreting your print file. | |
146 | ||
147 | ||
148 | LEGAL STUFF | |
149 | ----------- | |
150 | ||
e1613057 | 151 | Copyright © 2007-2018 by Apple Inc. |
82341b0b | 152 | Copyright © 1997-2007 by Easy Software Products. |
2a20b512 | 153 | |
e3101897 MS |
154 | CUPS is provided under the terms of the Apache License, Version 2.0. A copy of |
155 | this license can be found in the file `LICENSE`. Additional legal information | |
156 | is provided in the file `NOTICE`. | |
2a20b512 | 157 | |
e3101897 MS |
158 | Unless required by applicable law or agreed to in writing, software distributed |
159 | under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR | |
160 | CONDITIONS OF ANY KIND, either express or implied. See the License for the | |
161 | specific language governing permissions and limitations under the License. |