Debian Codegraph @

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

raw
1 .TH sane\-cardscan 5 "10 Feb 2010" "" "SANE Scanner Access Now Easy"
2 .IX sane\-cardscan
3
4 .SH NAME
5 sane\-cardscan \- SANE backend for Corex CardScan usb scanners
6
7 .SH DESCRIPTION
8 The
9 .B sane\-cardscan
10 library implements a SANE (Scanner Access Now Easy) backend which
11 provides access to the Corex CardScan 800c & 600c small-format scanners.
12
13 The backend supports only grayscale and color modes and media of
14 (theoretically) infinite length.
15
16 This backend may support other scanners. The best
17 way to determine level of support is to get a trace of the windows
18 driver in action, and send it to the author.
19
20 .SH OPTIONS
21 The cardscan backend supports the following options:
22
23 .TP
24 .B --mode Gray|Color
25 Selects the mode for the scan.
26
27 .SH CONFIGURATION FILE
28 The configuration file
29 .I cardscan.conf
30 is used to tell the backend how to look
31 for scanners, and provide options controlling the operation of the backend.
32 This file is read each time the frontend asks the backend for a list
33 of scanners, generally only when the frontend starts. If the configuration
34 file is missing, the backend will use a set of compiled defaults, which
35 are identical to the default configuration file shipped with SANE.
36 .PP
37 Scanners can be specified in the configuration file in 2 ways:
38 .PP
39 "usb 0x04c5 0x1042" (or other vendor/product ids)
40 .RS
41 Requests backend to search all usb buses in the system for a device
42 which uses that vendor and product id. The device will then be queried
43 to determine if it is a cardscan scanner.
44 .RE
45 .PP
46 "usb /dev/usb/scanner0" (or other device file)
47 .RS
48 Some systems use a kernel driver to access usb scanners. This method is untested.
49 .RE
50
51 Additionally, there are two configuration options that control the protocol
52 used by the backend:
53
54 .PP
55 "lines_per_block 16" (or other number from 1 to 32)
56 .RS
57 Controls the number of lines of image data which will be acquired in each pass.
58 Older scanners will require this number set lower, often 1.
59 .RE
60 .PP
61 "has_cal_buffer 1" (1 or 0)
62 .RS
63 Causes the backend to get calibration data from scanner during initialization.
64 Older scanners do not support this request, and must be set to 0.
65 .RE
66
67 .SH ENVIRONMENT
68 The backend uses a single environment variable,
69 .BR SANE_DEBUG_CARDSCAN,
70 which enables debugging output to stderr. Valid values are:
71 .PP
72 .RS
73 5 Errors
74 .br
75 10 Function trace
76 .br
77 15 Function detail
78 .br
79 20 Option commands
80 .br
81 25 SCSI/USB trace
82 .br
83 30 SCSI/USB detail
84 .br
85 35 Useless noise
86 .RE
87
88 .SH KNOWN ISSUES
89 .PP
90 .RS
91 The scanner does not seem to have much control possible, so the backend
92 cannot set x/y coordinate values, resolutions, etc. These things could
93 be simulated in the backend, but there are plenty of command line tools.
94 .br
95 .br
96 The backend also does not send all the commands that the windows driver
97 does, so it may not function the same.
98 .br
99 .br
100 The backend does not have the calibration or ejection options of the
101 windows driver.
102 .br
103 .br
104 .RE
105
106 .SH CREDITS
107 The hardware to build this driver was provided to the author by:
108 Jeff Kowalczyk
109 .IR "<jtk a t yahoo d o t com>" .
110
111 .SH "SEE ALSO"
112 .BR sane (7),
113 .BR sane\-usb (5)
114
115 .SH AUTHOR
116 m. allan noah:
117 .I "<kitno455 a t gmail d o t com>" .