Debian Codegraph @

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

raw
1 .TH sane\-coolscan3 5 "11 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-coolscan3
3 .SH NAME
4 sane\-coolscan3 \- SANE backend for Nikon Coolscan film scanners
5 .SH DESCRIPTION
6 The
7 .B sane\-coolscan3
8 library implements a SANE (Scanner Access Now Easy) backend that
9 provides access to Nikon Coolscan film scanners. Some functions of this
10 backend should be considered
11 .B beta-quality
12 software. Most functions have been stable for a long time, but of
13 course new development can not and will not function properly from
14 the very first day.
15
16 .PP
17 At present, the following scanners are known to work with this backend:
18 .PP
19 .RS
20 .ft CR
21 .nf
22 Model: Connection Type
23 --------------------------- -------------------
24 LS-30 (Coolscan III) SCSI
25 LS-40 ED (Coolscan IV) USB
26 LS-50 ED (Coolscan V) USB
27 LS-2000 SCSI
28 LS-4000 ED IEEE 1394
29 LS-8000 ED IEEE 1394
30 .fi
31 .ft R
32 .RE
33
34 Please send mail to
35 .I [email protected]
36 to report successes or failures.
37
38 .SH OPTIONS
39 The options the backend supports can either be selected through command line
40 options to programs like
41 .BR scanimage (1)
42 or through GUI elements in
43 .BR xscanimage (1)
44 or
45 .BR xsane (1).
46
47 Valid command line options and their syntax can be listed by using:
48 .PP
49 .RS
50 scanimage \-\-help \-d coolscan3:<interface>:<device>
51 .RE
52 .PP
53 where <interface> and <device> specify the device in question, as in the
54 configuration file (see next section). The
55 .B \-d
56 parameter and its argument can be omitted to obtain information on the
57 first scanner identified. Use the command:
58 .PP
59 .RS
60 scanimage \-L
61 .RE
62 .PP
63 to list all devices recognized by your SANE installation.
64
65 The options should be fully described by the description or tooltips given by
66 frontend. Here is a description of some of the most important options, in the
67 syntax with which they must be supplied to
68 .BR scanimage (1):
69 .TP
70 .B \-\-frame <n>
71 This option specifies which frame to operate on, if a motorized film strip
72 feeder or APS adapter are used. The frame number
73 .I <n>
74 ranges from 1 to the number of frames available, which is sensed each time
75 the backend is initialized (usually each time you start the frontend).
76 .TP
77 .B \-\-subframe <x>
78 This option shifts the scan window by the specified amount (default
79 unit is mm).
80 .TP
81 .B \-\-infrared=yes/no
82 If set to "yes", the scanner will read the infrared channel, thus allowing
83 defect removal in software. The infrared image is read during a second scan,
84 with no options altered. The backend must not be restarted between the scans.
85 If you use
86 .BR scanimage (1),
87 perform a batch scan with
88 .B \-\-batch\-count=2
89 to obtain the IR information.
90 .TP
91 .B \-\-depth <n>
92 Here <n> can either be 8 or the maximum number of bits supported by the
93 scanner (10, 12, or 14). It specifies whether or not the scanner reduces
94 the scanned data to 8 bits before sending it to the backend. If 8 bits are
95 used, some information and thus image quality is lost, but the amount of data
96 is smaller compared to higher depths. Also, many imaging programs and image
97 formats cannot handle depths greater than 8 bits.
98 .TP
99 .B \-\-autofocus
100 Perform autofocus operation. Unless otherwise specified by the other options (
101 .B \-\-focus\-on\-centre
102 and friends), focusing is performed on the centre of the selected scan area.
103 .TP
104 .B \-\-ae\-wb
105 .TP
106 .B \-\-ae
107 Perform a pre-scan to calculate exposure values automatically.
108 .B \-\-ae\-wb
109 will maintain the white balance, while
110 .B \-\-ae
111 will adjust each channel separately.
112 .TP
113 .B \-\-exposure
114 Multiply all exposure times with this value. This allows exposure
115 correction without modifying white balance.
116 .TP
117 .B \-\-load
118 Load the next slide when using the slide loader (SF\-200 bulk loader only).
119 .TP
120 .B \-\-eject
121 Eject the film strip or mounted slide when using the slide loader.
122 .TP
123 .B \-\-reset
124 Reset scanner. The scanner will perform the same action as when power is
125 turned on: it will eject the slide (with the SF\-200 bulk loader)
126 and calibrate itself. Use this
127 whenever the scanner refuses to load a slide properly, as a result of
128 which
129 .B \-\-eject
130 does not work.
131
132 .SH CONFIGURATION FILE
133 The configuration file
134 .I /etc/sane.d/coolscan3.conf
135 specifies the device(s) that the backend will use. Owing to the nature of
136 the supported connection types SCSI, USB, and IEEE 1394, the default
137 configuration file supplied with the SANE distribution should work without
138 being edited.
139
140 Each line in the configuration file is either of the following, where all
141 entries are case-sensitive:
142 .TP
143 .I blank or starting with a '#' character
144 These lines are ignored, thus '#' can be used to include comments.
145 .TP
146 .I containing only the word """auto"""
147 This instructs the backend to probe for a scanner by scanning the buses for
148 devices with known identifiers. This is the default action when no
149 configuration file is present.
150 .TP
151 .I a line of the form <interface>:<device>
152 Here <interface> can be one of "scsi" or "usb", and <device> is the device
153 file of the scanner. Note that IEEE 1394 devices are handled by the SBP-2
154 module in the kernel and appear to SANE as SCSI devices.
155
156 .SH FILES
157 .TP
158 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-coolscan3.a
159 The static library implementing this backend.
160 .TP
161 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-coolscan3.so
162 The shared library implementing this backend (present on systems that
163 support dynamic loading).
164 .TP
165 .I /etc/sane.d/coolscan3.conf
166 Configuration file for this backend, read each time the backend is
167 initialized.
168
169 .SH ENVIRONMENT
170 .TP
171 .B SANE_DEBUG_COOLSCAN3
172 If the library was compiled with debug support enabled, this
173 environment variable controls the debug level for this backend. E.g.,
174 a value of 128 requests all debug output to be printed. Smaller
175 levels reduce verbosity.
176
177 .SH "SEE ALSO"
178 .BR sane\-scsi (5),
179 .BR sane\-usb (5),
180 .BR scanimage (1),
181 .BR xscanimage (1),
182 .BR xsane (1)
183
184 .SH BUGS
185 Currently, the SANE protocol does not allow automatically updating options
186 whenever the hardware changes. Thus the number of choices for the
187 .B \-\-frame
188 option will be fixed when the backend is initialized (usually when the user
189 runs the frontend). In particular, if there is no film strip in the
190 automatic film strip feeder when the backend is initialized, the
191 .B \-\-frame
192 option will not appear at all.
193 Also, restarting the frontend after swapping film adapters is strongly recommended.
194
195 Linux kernels prior to 2.4.19 had a patch that truncated INQUIRY data
196 from IEEE 1394 scanners to 36 bytes, discarding vital information
197 about the scanner. The IEEE 1394 models therefore only work with
198 2.4.19 or later.
199
200 No real bugs currently known, please report any to the SANE developers' list.
201
202 .SH AUTHORS
203 coolscan3 written by A. Zummo
204 .RI < [email protected] >,
205 based heavily on coolscan2 written by Andr\['a]s Major
206 .RI < [email protected] >.