Add packaging/epson-inkjet-printer-escpr.changes file
[platform/upstream/epson-inkjet-printer-escpr.git] / README
1 Epson Inkjet Printer Driver (ESC/P-R) Manual
2
3 Copyright (C) Seiko Epson Corporation 2005-2012.
4
5 Please visit our website for the latest information.
6 Please refer to follows for the information about this driver
7 http://download.ebz.epson.net/dsc/search/01/search/?OSC=LX
8
9
10 Contents
11 1  License Agreement
12 2  Revision History
13 3  Product Description
14 4  Installation and CUPS setting
15     4.1  Installing
16     4.2  Settings after installation
17 5  Printing
18     5.1  Items to be set
19     5.2  Details of setting items
20     5.3  How to Set
21     5.4  How to Print
22 6  How to build in non-LSB distribution
23     6.1  For Redhat based distributions
24     6.2  For Debian based distributions
25     6.3  Other distributions
26 7  Acknowledgments
27
28
29 -------------------------------------------------------------------------------
30 1  License Agreement
31 -------------------------------------------------------------------------------
32 This software is covered by the GNU General Public License (GPL). 
33 Refer to the file "COPYING" for more information about the GPL.
34
35 -------------------------------------------------------------------------------
36 2  Revision History
37 -------------------------------------------------------------------------------
38 See ./NEWS.
39
40
41 -------------------------------------------------------------------------------
42 3  Product Description
43 -------------------------------------------------------------------------------
44 This software is a filter program used with the Common UNIX Printing
45 System (CUPS) on the Linux platform.
46 The software offers high quality printing with Seiko Epson color ink jet printers.
47
48 This product can only be used with printers that support the Epson ESC/P-R language.
49
50 Please see refer to follows for a list of supported printers.
51 http://download.ebz.epson.net/dsc/search/01/search/?OSC=LX
52
53 This software is based on LSB 3.2. It can be used in distribution supporting LSB 3.2 later.
54 If it is used in non-LSB distribution, you can use it by building from the source code.
55
56 -------------------------------------------------------------------------------
57 4  Installation and CUPS Setting
58 -------------------------------------------------------------------------------
59 4.1  Installation
60         4.1.1  In the case of LSB supported distributions
61            Choose the appropriate command for your distribution from the list below
62            and execute it with root privileges.
63            Note: The following package name differs depending on the version
64            you are using.
65            For Redhat based distributions:
66            -----------------
67            # rpm -i epson-inkjet-printer-escpr-1.2.2-1lsb3.2.i486.rpm
68            -----------------
69            For Debian based distributions:
70            -----------------
71            # dpkg -i epson-inkjet-printer-escpr_1.2.2-1lsb3.2_i386.deb
72            -----------------
73            
74         4.1.2  In the case of non-LSB supported distributions
75            Refer to "6  How to build in non-LSB distribution".
76
77
78 4.2  Settings after installation
79    CUPS must be set to enable use of this software.
80    Before printing, be sure to carry out the following steps.
81
82         4.2.1  Restart CUPS
83              Restart CUPS, to enable the installed filter.
84              Execute the following command with root privileges.
85
86              Example: With Red Hat Linux
87              -----------------
88              # /etc/init.d/cups restart
89              -----------------
90              With Debian GNU/Linux
91              -----------------
92              # /etc/init.d/cupsys restart
93              -----------------
94
95         4.2.2  Add a printer
96
97           Using commands
98              Execute the following command with root privileges.
99              -----------------
100              # lpadmin -p [PRINTER_NAME] -v [DEVICE_URI] -P [PPD_FILE] -E
101              -----------------
102
103              Options: -p      Specifies the setting name of the printer
104                                 -E      Enables the printer
105                                 -v      Specifies the driver and connection
106                                 -P      Specifies the setting file (PPD file)
107
108              Example: With the PM-A950 printer 
109              -----------------
110              # lpadmin -p ep901a -v usb:/EPSON/EP-901A -P /opt/epson-inkjet-printer-escpr/ppds/EPSON/EPSON-EP-901A-epson-escpr-en.ppd.gz -E
111              -----------------
112
113              For details of lpadmin, see lpadmin(8).
114
115
116           Using a browser
117              CUPS is provided with a CGI for settings so that you can set your printer
118              using a browser. To add a printer, follow the steps below.
119                Note: The following menu items might differ depending on the CUPS
120                      version and the environment used.
121
122              (1) Turn on the printer, and please be connected to the PC with a USB cable.
123              (2) Connect to CUPS Server (Port: 631) with the browser
124                  Example: When CUPS is on localhost, access the following URL.
125                      -----------------
126                      http://localhost:631/
127                      -----------------
128              (3) Select "Add Printer"
129              (4) Enter a printer setting name in "Name", and select "Continue"
130                   (Other items are not mandatory)
131              (5) In "Device", USB, and select "Continue"
132                  Example: With the EP-901A printer, "Model" is displayed as follows.
133                      -----------------
134                      "EP-901A USB #1(EP-901A)"
135                      -----------------
136              (6) In "Model", set "EPSON-ESC/P-R Printer Driver for Linux", and
137                  select "Add Printer"
138                  Example: With the EP-901A printer, "Model" is displayed as follows.
139                      -----------------
140                      "EPSON EP-901A, EPSON-ESC/P-R Printer Driver for Linux (en,en,ja,nl,fr,de,it,pt,es,ko,zh_CN,zh_TW)"
141                      -----------------
142              (6') Instead of steps (6), specify the PPD file directly from "Browse"
143                   Example: With the EP-901A printer, you would specify the following file.
144                       -----------------
145                       /opt/epson-inkjet-printer-escpr/ppds/EPSON/EPSON-EP-901A-epson-escpr-en.ppd.gz
146                       -----------------
147
148 This completes adding a printer for this software.
149
150
151 -------------------------------------------------------------------------------
152 5  Printing
153 -------------------------------------------------------------------------------
154 5.1  Items to be set
155    The following items can be set with this software.
156
157    * Ink
158         Select color or monochrome printing.
159
160    * Paper size
161         Select the paper size for your document.
162
163    * Print quality
164         Select the media type and its print quality for your printing.
165
166
167 5.2  Details of setting items
168    Followings is a list of setting options available for this software.
169
170    * The meaning of the list items
171      - Keyword          Text string used when specifying an option
172      - Browser display  Text string displayed in the browser window for CUPS settings
173      - Explanation      An explanation of the setting
174
175    Ink
176       Setting name for optional settings: Ink
177       Setting name in the browser: Ink
178
179       Keyword  | Browser display        | Explanation
180       ---------+------------------------+------------------------------------
181       COLOR    | Color                  | Color printing
182       MONO     | Monochrome             | Monochrome printing
183
184    Paper size
185       Setting name for optional settings: PageSize or media
186       Setting name in the browser: MediaSize
187
188       Note: When adding multiple settings in the media option, put paper size
189             at the beginning. For the media options, see the CUPS documentation.
190
191    Print quality
192       Setting name for optional settings: Quality
193       Setting name in the browser: Quality
194
195
196 5.3  How to set
197
198    There are three methods for print settings.
199
200    * Using commands
201         Use lpoptions. For details of the command, see lpoptions(1).
202
203         Example: For the registered printer name ep901a
204             To specify ink = COLOR, page size = A4, quality = PLAIN_NORMAL
205         -----------------
206         $ lpoptions -p ep901a -o ink=COLOR -o media=A4 -o quality=PLAIN_NORMAL
207         -----------------
208
209    * Use a browser
210         Select "Configure Printer" from the printer window to display
211         the setting window.
212
213    * Specify options when printing
214         As with lpoptions, set options with -o. For details of the commands,
215         see lpr(1) and lp(1).
216
217 5.4  How to Print
218
219    To print, as with the existing LPR, execute the lpr or lp commands.
220    The formats that can be printed are as follows.
221
222    * Postscript
223    * PDF
224    * Text
225    * Various image files
226
227    Example:
228       When printing with the defaults
229       -----------------
230       $ lpr -P PRINTER_NAME <file>
231       $ lp -d PRINTER_NAME <file>
232       -----------------
233
234       With printer_name = a950, ink = MONO, media = Legal
235       -----------------
236       $ lpr -P a950 -o ink=MONO -o media=Legal <file>
237       $ lp -d a950 -o ink=MONO -o media=Legal <file>
238       -----------------
239
240 The method of printing depends on the implementation of CUPS.
241 For more details, see the CUPS documentation.
242
243 -------------------------------------------------------------------------------
244 6  How to build in non-LSB distribution
245 -------------------------------------------------------------------------------
246 6.1  For Redhat based distributions
247         6.1.1  Uncompress the src.rpm file
248            $ rpm2cpio epson-inkjet-printer-escpr-1.2.2-1lsb3.2.src.rpm | cpio -id
249            $ tar zxvf epson-inkjet-printer-escpr-1.2.2-1lsb3.2.tar.gz
250
251         6.1.2  Configure and Create source tarball
252            $ cd epson-inkjet-printer-escpr-1.2.2
253            $ ./bootstrap && ./configure --prefix=/usr && make dist
254
255         6.1.3  Create the directory for RPM packages
256            $ mkdir -p ~/rpmbuild/SOURCES
257            $ mkdir -p ~/rpmbuild/SPECS
258            $ mkdir -p ~/rpmbuild/BUILD
259            $ mkdir -p ~/rpmbuild/RPMS
260            $ mkdir -p ~/rpmbuild/SRPMS
261            
262            You can specifiy the another directory in ~/.rpmmacros
263            
264         6.1.4  Copy the source tarball and the spec file to the directory
265            $ cp epson-inkjet-printer-escpr-1.2.2.tar.gz ~/rpmbuild/SOURCES/.
266            $ cp epson-inkjet-printer-escpr.spec ~/rpmbuild/SPECS
267
268         6.1.5  Create RPM package
269            $ cd ~/rpmbuild/SPECS
270            $ rpmbuild -ba --clean epson-inkjet-printer-escpr.spec
271
272
273 6.2  For Debian based distributions
274         6.2.1  Uncompress the src.rpm file
275            $ rpm2cpio epson-inkjet-printer-escpr-1.2.2-1lsb3.2.src.rpm | cpio -id
276            $ tar zxvf epson-inkjet-printer-escpr-1.2.2-1lsb3.2.tar.gz
277
278         6.2.2  Configure
279            $ cd epson-inkjet-printer-escpr-1.2.2
280            $ ./bootstrap && ./configure --prefix=/usr
281
282         6.2.3  Create DEB package
283            $ make
284            $ debuild -us -uc -b
285
286 6.3  For other distributions
287         6.3.1  Uncompress the src.rpm file
288            $ rpm2cpio epson-inkjet-printer-escpr-1.2.2-1lsb3.2.src.rpm | cpio -id
289            $ tar zxvf epson-inkjet-printer-escpr-1.2.2-1lsb3.2.tar.gz
290
291         6.3.2  Configure
292            $ cd epson-inkjet-printer-escpr-1.2.2
293            $ ./bootstrap && ./configure --prefix=/usr
294
295         The location of CUPS filter and ppd files are decided automatically,
296         but you can specify with the follwing configure options.
297         
298         * "--with-cupsfilterdir"    The location of CUPS filter
299                                     ex) /usr/lib/cups/filter
300                                     
301         * "--with-cupsppddir"       The location of PPD files
302                                     ex) /usr/share/ppd
303
304         6.3.3  Make and Install
305            $ cd epson-inkjet-printer-escpr-1.2.2
306            $ make 
307            $ sudo make install
308
309
310 -------------------------------------------------------------------------------
311 7  Acknowledgments
312 -------------------------------------------------------------------------------
313     We express our appreciation to the following people for cooperating with us
314     in developing this product.
315
316 (In no particular order)
317     Nobby N Hirano <nobby@nmail.hiug.ne.jp>
318     Toshihiro Yamagishi <toshihiro@turbolinux.co.jp>
319     Nozomi Sato <nozomi@esd.spr.epson.co.jp>
320
321 ***End of file