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