]> git.ipfire.org Git - thirdparty/cups.git/blob - README.txt
Merge CUPS 1.4svn-r8052 (tentative 1.4b1)
[thirdparty/cups.git] / README.txt
1 README - CUPS v1.4b1 - 2008-10-10
2 ---------------------------------
3
4 **********************************************************************
5 **********************************************************************
6 ********** **********
7 ********** THIS IS BETA-RELEASE SOFTWARE. DO NOT USE ON **********
8 ********** PRODUCTION SYSTEMS! REPORT PROBLEMS TO THE **********
9 ********** CUPS FORUMS OR BUG REPORTING PAGES: **********
10 ********** **********
11 ********** http://www.cups.org/newsgroups.php (FORUMS) **********
12 ********** http://www.cups.org/str.php (BUGS) **********
13 ********** **********
14 **********************************************************************
15 **********************************************************************
16
17 Looking for compile instructions? Read the file "INSTALL.txt"
18 instead...
19
20
21 INTRODUCTION
22
23 CUPS provides a portable printing layer for UNIX(r)-based
24 operating systems. It was developed by Easy Software Products
25 and is now owned and maintained by Apple Inc. to promote a
26 standard printing solution for all UNIX vendors and users. CUPS
27 provides the System V and Berkeley command-line interfaces.
28
29 CUPS uses the Internet Printing Protocol ("IPP") as the basis
30 for managing print jobs and queues. The Line Printer Daemon
31 ("LPD") Server Message Block ("SMB"), and AppSocket (a.k.a.
32 JetDirect) protocols are also supported with reduced
33 functionality. CUPS adds network printer browsing and
34 PostScript Printer Description ("PPD") based printing options
35 to support real-world printing under UNIX.
36
37 CUPS includes an image file RIP that supports printing of
38 image files to non-PostScript printers. GPL Ghostscript now
39 includes the "cups" driver to support printing of PostScript
40 files within the CUPS driver framework. Sample drivers for
41 Dymo, EPSON, HP, OKIDATA, and Zebra printers are included that
42 use these filters.
43
44 CUPS is licensed under the GNU General Public License and GNU
45 Library General Public License versions 2.
46
47
48 READING THE DOCUMENTATION
49
50 Once you have installed the software you can access the
51 documentation (and a bunch of other stuff) on-line at:
52
53 http://localhost:631/
54
55 If you're having trouble getting that far, the documentation
56 is located under the "doc/help" directory.
57
58 Please read the documentation before asking questions.
59
60
61 GETTING SUPPORT AND OTHER RESOURCES
62
63 If you have problems, READ THE DOCUMENTATION FIRST! We also
64 provide many discussion forums which are available at:
65
66 http://www.cups.org/newsgroups.php
67
68 See the CUPS web site at "http://www.cups.org/" for other
69 site links.
70
71
72 SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER
73
74 CUPS 1.3 includes a web-based administration tool that allows
75 you to manage printers, classes, and jobs on your server.
76 Open the following URL in your browser to access the printer
77 administration tools:
78
79 http://localhost:631/admin/
80
81 DO NOT use the hostname for your machine - it will not work
82 with the default CUPS configuration. To enable
83 administration access on other addresses, check the "Allow
84 Remote Administration" box and click on the "Change Settings"
85 button.
86
87 You will be asked for the administration password (root or
88 any other user in the sys/system/root group on your system)
89 when performing any administrative function.
90
91
92 SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE
93
94 CUPS works best with PPD (PostScript Printer Description)
95 files. In a pinch you can also use System V style printer
96 interface scripts.
97
98 CUPS includes several sample PPD files you can use:
99
100 Driver PPD File
101 ----------------------------- ------------------------------
102 Dymo Label Printers drv:///sample.drv/dymo.ppd
103 Intellitech Intellibar drv:///sample.drv/intelbar.ppd
104 EPSON Stylus Color Series drv:///sample.drv/stcolor.ppd
105 EPSON Stylus Photo Series drv:///sample.drv/stphoto.ppd
106 EPSON Stylus New Color Series drv:///sample.drv/stcolor2.ppd
107 EPSON Stylus New Photo Series drv:///sample.drv/stphoto2.ppd
108 EPSON 9-pin Series drv:///sample.drv/epson9.ppd
109 EPSON 24-pin Series drv:///sample.drv/epson24.ppd
110 HP DeskJet Series drv:///sample.drv/deskjet.ppd
111 HP LaserJet Series drv:///sample.drv/laserjet.ppd
112 OKIDATA 9-Pin Series drv:///sample.drv/okidata9.ppd
113 OKIDATA 24-Pin Series drv:///sample.drv/okidat24.ppd
114 Zebra CPCL Label Printer drv:///sample.drv/zebracpl.ppd
115 Zebra EPL1 Label Printer drv:///sample.drv/zebraep1.ppd
116 Zebra EPL2 Label Printer drv:///sample.drv/zebraep2.ppd
117 Zebra ZPL Label Printer drv:///sample.drv/zebra.ppd
118
119 Run the "lpinfo -m" command to list the available drivers:
120
121 lpinfo -m
122
123 Run the "lpinfo -v" command to list the available printers:
124
125 lpinfo -v
126
127 Then use the correct URI to add the printer using the
128 "lpadmin" command:
129
130 lpadmin -p printername -E -v URI -m filename.ppd
131
132 Network printers typically use "socket" or "lpd" URIs:
133
134 lpadmin -p printername -E -v socket://11.22.33.44 -m filename.ppd
135 lpadmin -p printername -E -v lpd://11.22.33.44/ -m filename.ppd
136
137 The sample drivers provide basic printing capabilities, but
138 generally do not exercise the full potential of the printers
139 or CUPS.
140
141
142 PRINTING FILES
143
144 CUPS provides both the System V "lp" and Berkeley "lpr"
145 commands for printing:
146
147 lp filename
148 lpr filename
149
150 Both the "lp" and "lpr" commands support printing options for
151 the driver:
152
153 lp -omedia=A4 -oresolution=600dpi filename
154 lpr -omedia=A4 -oresolution=600dpi filename
155
156 CUPS recognizes many types of images files as well as PDF,
157 PostScript, HP-GL/2, and text files, so you can print those
158 files directly rather than through an application.
159
160 If you have an application that generates output specifically
161 for your printer then you need to use the "-oraw" or "-l"
162 options:
163
164 lp -oraw filename
165 lpr -l filename
166
167 This will prevent the filters from misinterpreting your print
168 file.
169
170
171 LEGAL STUFF
172
173 CUPS is Copyright 2007-2008 by Apple Inc. CUPS, the CUPS logo,
174 and the Common UNIX Printing System are trademarks of Apple Inc.
175
176 The MD5 Digest code is Copyright 1999 Aladdin Enterprises.
177
178 This software is based in part on the work of the Independent
179 JPEG Group.
180
181 CUPS is provided under the terms of version 2 of the GNU General
182 Public License and GNU Library General Public License. This program
183 is distributed in the hope that it will be useful, but WITHOUT ANY
184 WARRANTY; without even the implied warranty of MERCHANTABILITY or
185 FITNESS FOR A PARTICULAR PURPOSE. See the "doc/help/license.html"
186 or "LICENSE.txt" files for more information.