Debian Codegraph @

upstream/debian-unstable/man5/sane-canon_pp.5

raw
1 .TH sane\-canon_pp 5 "11 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-canon_pp
3 .SH NAME
4 sane\-canon_pp \- SANE backend for Canon CanoScan Parallel Port flatbed scanners
5 .SH DESCRIPTION
6 The
7 .B sane\-canon_pp
8 library implements a SANE (Scanner Access Now Easy) backend that provides
9 access to the following Canon flatbed scanners:
10 .PP
11 .RS
12 CanoScan FB320P
13 .br
14 CanoScan FB620P
15 .br
16 CanoScan FB330P
17 .br
18 CanoScan FB630P
19 .br
20 CanoScan N340P
21 .br
22 CanoScan N640P
23 .br
24 CanoScan N640P ex
25 .br
26 .RE
27 .PP
28 No USB scanners are supported and there are no plans to support them in the
29 future. Other projects are working on support for USB scanners. See the
30 .I PROJECTS
31 file for more detail. The FB310P and FB610P are re-badged Avision scanners
32 which use a different command set, so are unlikely to be supported by this
33 backend in the future.
34 .PP
35 IMPORTANT: this is alpha code. While we have made every effort to make it as
36 reliable as possible, it will not always work as expected. Feedback is still
37 appreciated. Please send any bug reports to the maintainers as listed on the
38 web page (listed in
39 .B SEE ALSO
40 below).
41
42 .SH "DEVICE NAMES"
43 This backend expects device names of the form presented by
44 .BR libieee1284 (3).
45 These names are highly dependent on operating system and version.
46
47 On Linux 2.4 kernels this will be of the form
48 .I "parport0"
49 or older (2.2 and before) kernels may produce names like
50 .IR "0x378"
51 (the base address of your port) or simply
52 .IR "0"
53 depending on your module configuration. Check the contents of
54 .I /proc/parport
55 if it exists. If you don't want to specify a default port (or don't know its
56 name), the backend should be able to detect which port your scanner is on.
57
58 .SH CONFIGURATION
59 The contents of the
60 .I canon_pp.conf
61 file is a list of options for the driver to use. Empty lines and lines
62 starting with a hash mark (#) are ignored.
63 .PP
64 The supported options are currently
65 .BR ieee1284 ,
66 .BR calibrate ,
67 .BR init_mode ,
68 and
69 .BR force_nibble
70
71 .TP
72 .B ieee1284 port-name
73 Defines which port to use. The format of port-name is OS dependent, based on
74 the names presented by
75 .BR libieee1284 (3).
76 Please only have one of these lines, or
77 all but one will be ignored.
78
79 .TP
80 .B calibrate cal-file [port-name]
81 Defines which calibration file to use on a per-port basis. If you only have
82 one parport, the port-name argument may be omitted \- but be careful as this
83 will cause problems on multi-scanner systems. You may have as many of these
84 lines as you like, as long as each has a unique port name. The tilde (`~')
85 character is acceptable and will be expanded to the value of the
86 .B HOME
87 environment variable.
88
89 .TP
90 .B init_mode <AUTO|FB620P|FB630P> [port-name]
91 Defines which initialisation (wake-up) mode to use on a per-port basis.
92 If you only have one parport, the port-name argument may be omitted \- but
93 be careful as this may cause problems on multi-scanner systems.
94 You may have as many of these lines as you like, as long as each has a unique
95 port name. The valid initialisation modes are FB620P (which strobes 10101010
96 and 01010101 on the data pins), FB630P (which strobes 11001100 and 00110011
97 on the data pins) and AUTO, which will try FB630P mode first then FB620P mode
98 second. The FB620P mode is also used by the FB320P. The FB630P mode is used
99 by the FB330P, N340P, and N640P.
100
101 .TP
102 .B force_nibble
103 Forces the driver to use nibble mode even if ECP mode is reported to work by
104 .BR libieee1284 (3).
105 This works-around the rare issue of ECP mode being reported to
106 work by the library, then not working.
107
108 .SH TIPS
109 .PP
110 Hit the "Calibrate" button before scanning. It vastly improves the quality of
111 scans.
112 .PP
113 To enable automatic detection of your scanner, uncomment the "canon_pp" line
114 from
115 .I /etc/sane.d/dll.conf
116 .PP
117 .SH FILES
118 .TP
119 .I /etc/sane.d/canon_pp.conf
120 The backend configuration file (see also description of
121 .B SANE_CONFIG_DIR
122 below).
123 .TP
124 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-canon_pp.a
125 The static library implementing this backend.
126 .TP
127 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-canon_pp.so
128 The shared library implementing this backend (present on systems that support
129 dynamic loading).
130 .SH ENVIRONMENT
131 .TP
132 .B SANE_CONFIG_DIR
133 This environment variable specifies the list of directories that may contain
134 the configuration file. On *NIX systems, the directories are separated by a colon
135 (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable
136 is not set, the configuration file is searched in two default directories:
137 first, the current working directory (".") and then in
138 .IR /etc/sane.d .
139 If the value of the environment variable ends with the directory separator
140 character, then the default directories are searched after the explicitly
141 specified directories. For example, setting
142 .B SANE_CONFIG_DIR
143 to "/tmp/config:" would result in directories
144 .IR tmp/config ,
145 .IR . ,
146 and
147 .I /etc/sane.d
148 being searched (in this order).
149 .TP
150 .B SANE_DEBUG_CANON_PP
151 If the library was compiled with debug support enabled, this environment
152 variable controls the debug level for this backend. Higher debug levels
153 increase the verbosity of the output.
154
155 Example:
156 export SANE_DEBUG_CANON_PP=4
157 .SH NOTES
158 .B Features available in the Windows interface
159 .TP
160 .B Brightness and Contrast
161 These are not implemented, and probably never will be. These appear to be
162 implemented entirely in software. Use GIMP or a similar program if you need
163 these features.
164 .TP
165 .B Descreen Mode
166 This appears on our first analysis to be just oversampling with an
167 anti-aliasing filter. Again, it seems to be implemented entirely in software,
168 so GIMP is your best bet for now.
169 .TP
170 .B Gamma Tables
171 This is under investigation, but for now only a simple gamma profile (ie: the
172 one returned during calibration) will be loaded.
173 .PP
174 .B Communication Problems
175 .PP
176 ECP mode in
177 .BR libieee1284 (3)
178 doesn't always work properly, even with new hardware.
179 We believe that this is a ppdev problem. If you change the configuration file
180 to include
181 .B force_nibble
182 , the problem will go away, but you will only be able to scan in nibble mode.
183 .PP
184 Sometimes the scanner can be left in a state where our code cannot revive it.
185 If the backend reports no scanner present, try unplugging the power and
186 plugging it back in. Also try unplugging printers from the pass-through port.
187 .PP
188 The scanner will not respond correctly to our commands when you first plug in
189 the power. You may find if you try a scan very soon after plugging in the
190 power that the backend will incorrectly report that you have no scanner present.
191 To avoid this, give it about 10 seconds to reset itself before attempting any
192 scans.
193 .PP
194 .B Repeated Lines
195 .PP
196 Sometimes at high resolutions (ie. 600dpi) you will notice lines which appear
197 twice. These lines correspond to points where the scanner head has stopped
198 during the scan (it stops every time the internal 64kb buffer is full).
199 Basically it's a mechanical problem inside the scanner, that the tolerance of
200 movement for a start/stop event is greater than 1/600 inches. I've never tried
201 the windows driver so I'm not sure how (or if) it works around this problem,
202 but as we don't know how to rewind the scanner head to do these bits again,
203 there's currently no nice way to deal with the problem.
204 .PP
205 .B Grey-scale Scans
206 .PP
207 Be aware that the scanner uses the green LEDs to read grey-scale scans, meaning
208 green coloured things will appear lighter than normal, and red and blue
209 coloured items will appear darker than normal. For high-accuracy grey-scale
210 scans of colour items, it's best just to scan in colour and convert to
211 grey-scale in graphics software such as the GIMP.
212 .PP
213 .B FB620P/FB320P Caveats
214 .PP
215 These models can not be reset in the same way as the others. The windows driver
216 doesn't know how to reset them either \- when left with an inconsistent scanner,
217 it will start scanning half way down the page!
218 .PP
219 Aborting is known to work correctly on the FB*30P models, and is known to be
220 broken on the FB*20P models. The FB620P which I tested on simply returns
221 garbage after a scan has been aborted using the method we know.
222 Aborting is able to leave the scanner in a state where it can be shut down,
223 but not where another scan can be made.
224
225
226 .SH "SEE ALSO"
227 .BR sane (7),
228 .BR sane\-dll(5),
229 .BR libieee1284 (3),
230 .br
231 .I http://canon\-fb330p.sourceforge.net/
232
233 .SH AUTHOR
234 This backend is primarily the work of Simon Krix (Reverse Engineering), and
235 Matthew Duggan (SANE interface).
236 .PP
237 Many thanks to Kevin Easton for his comments and help, and Kent A. Signorini
238 for his help with the N340P.