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