Debian Codegraph @

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

raw
1 .TH sane\-epjitsu 5 "15 Nov 2022" "" "SANE Scanner Access Now Easy"
2 .IX sane\-epjitsu
3
4 .SH NAME
5 sane\-epjitsu \- SANE backend for Epson-based Fujitsu USB scanners
6
7 .SH DESCRIPTION
8 The
9 .B sane\-epjitsu
10 library implements a SANE (Scanner Access Now Easy) backend which provides basic access the
11 Fujitsu fi\-60F/fi\-65F and ScanSnap S300/S1300(i)/S1100(i) scanners.
12
13 .SH HARDWARE SUPPORT
14 These scanners are fairly limited, only supporting a couple of modes and resolutions, and
15 always scanning full width. The backend supports missing modes (binary, grayscale) and
16 intermediate resolutions in software, but provides only minimal scan area controls. See
17 .B KNOWN ISSUES.
18
19 This backend may support other scanners. If physical inspection reveals an Epson chipset,
20 please contact the author for instructions on collecting a USB trace under Windows to verify.
21
22 .SH OPTIONS
23 A limited effort has been made to expose the standard options to the API. This allows a
24 frontend to set resolution, color mode, and choose the ADF setting. The
25 .B sane\-epjitsu
26 backend supports the following basic options for most scanners:
27 .PP
28 .B source s
29 .RS
30 Selects the source for the scan. Options may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex".
31 .RE
32 .PP
33 .B mode m
34 .RS
35 Selects the mode for the scan. Options may include "Lineart", "Gray", "Color".
36 .RE
37 .PP
38 .BR resolution , " y\-resolution"
39 .RS
40 Controls scan resolution. Setting
41 .B \-\-resolution
42 also sets
43 .BR \-\-y\-resolution ,
44 though this behavior is overridden by some frontends.
45 .RE
46 .PP
47 Other options will be available based on the capabilities of the scanner. Use
48 .I 'scanimage \-\-help'
49 to get a list. Be aware that some options may appear only when another option has been set, and that advanced options may be hidden by the frontend.
50 .PP
51 .SH CONFIGURATION FILE
52 The configuration file
53 .I "/etc/sane.d/epjitsu.conf"
54 is used to tell the backend how to look for scanners, and provide options controlling the operation of the backend. This file is read each time the frontend asks the backend for a list of scanners, generally only when the frontend starts. If the configuration file is missing, the backend will not work.
55 .PP
56 Scanners can be specified in the configuration file in two ways:
57 .PP
58 "usb 0x04c5 0x10c7" (or other vendor/product ids)
59 .RS
60 Requests backend to search all usb buses in the system for a device which uses that vendor and product id. The device will then be queried to determine if it is a supported scanner.
61 .RE
62 .PP
63 "usb /dev/usb/scanner0" (or other device file)
64 .RS
65 Some systems use a kernel driver to access usb scanners. This method is untested.
66 .RE
67 .PP
68 The only configuration option supported is "firmware /PATH/TO/FILE", allowing you to set the location of the firmware file you have extracted from the Windows driver.
69 .PP
70 .B Note:
71 This firmware is a copyrighted work of Fujitsu, so cannot be provided by the backend or the author. Please do not ask.
72 .PP
73 .B Note:
74 These scanners REQUIRE a firmware file to function. See the supplied configuration file for more detail.
75 .PP
76 .B Note:
77 This option may appear multiple times in the configuration file. It only applies to scanners discovered by 'usb' lines that follow this option.
78 .PP
79
80 .SH ENVIRONMENT
81 The backend uses a single environment variable,
82 .BR SANE_DEBUG_EPJITSU,
83 which enables debugging output to stderr. Valid values are:
84 .PP
85 .RS
86 5 Errors
87 .br
88 10 Function trace
89 .br
90 15 Function detail
91 .br
92 20 Option commands
93 .br
94 25 USB trace
95 .br
96 30 USB detail
97 .br
98 35 Useless noise
99 .RE
100
101 .SH KNOWN ISSUES
102 .PP
103 .RS
104 Only limited scan area options are exposed.
105 .br
106 .br
107 fi\-60F and fi\-65F hardware grayscale mode is not used, because the calibration code is not finished.
108 .RE
109
110 .SH CREDITS
111 S300 support funded by Microdea, Inc. and Archivista, GmbH.
112 .br
113 fi\-60F support funded by TrueCheck, Inc.
114 .br
115 Improved calibration code provided by Richard Goedeken.
116
117 .SH "SEE ALSO"
118 .BR sane (7),
119 .BR sane\-usb (5)
120 .BR scanimage (1)
121
122 .SH AUTHOR
123 m. allan noah:
124 .RI < "kitno455 a t gmail d o t com" >