Added documentation for gt68xx backend.

DEVEL_2_0_BRANCH-1
Henning Geinitz 2002-10-25 12:19:34 +00:00
rodzic 492b63060f
commit bc2a2f1d1c
4 zmienionych plików z 261 dodań i 30 usunięć

Wyświetl plik

@ -49,7 +49,7 @@ SECT5 = sane-abaton.5 sane-agfafocus.5 sane-apple.5 sane-as6e.5 sane-dll.5 \
sane-umax_pp.5 sane-umax1220u.5 sane-sm3600.5 sane-usb.5 \
sane-mustek_usb.5 sane-sceptre.5 sane-canon_pp.5 sane-canon630u.5 \
sane-teco1.5 sane-teco2.5 sane-teco3.5 sane-test.5 sane-sp15c.5 \
sane-coolscan2.5 sane-hpsj5s.5
sane-coolscan2.5 sane-hpsj5s.5 sane-gt68xx.5
SECT7 = sane.7
MANPAGES = $(SECT1) $(SECT5) $(SECT7)
READMES = README AUTHORS COPYING ChangeLog LEVEL2 LICENSE NEWS PROBLEMS \
@ -57,7 +57,7 @@ READMES = README AUTHORS COPYING ChangeLog LEVEL2 LICENSE NEWS PROBLEMS \
README.hp-ux README.linux README.netbsd README.openbsd README.os2 \
README.solaris README.unixware2 README.unixware7 TODO
DOCS = backend-writing.txt sane.ps sane.dvi
BACKDIRS= canon matsushita mustek mustek_usb umax sceptre teco
BACKDIRS= canon matsushita mustek mustek_usb umax sceptre teco gt68xx
LATEX = TEXINPUTS=$(srcdir):$$TEXINPUTS latex
DLH = TEXINPUTS=$(srcdir):$$TEXINPUTS dlh
MAN2HTML= nroff -man |\

Wyświetl plik

@ -1,7 +1,7 @@
:backend "gt68xx"
:status :alpha
:version "1.0-26"
;:manpage "sane-gt68xx"
:version "1.0-27"
:manpage "sane-gt68xx"
:url "http://www.meier-geinitz.de/sane/gt68xx-backend/"
:comment "Only the USB scanners mentioned below are supported. For other Mustek BearPaws, look at the Plustek backend."
:devicetype :scanner
@ -13,12 +13,10 @@
:model "BearPaw 1200 CS"
:interface "USB"
:status :untested
:comment "is detected, should work, comments are welcome"
:status :beta
:model "BearPaw 1200 CU"
:interface "USB"
:comment "works"
:status :beta
:model "BearPaw 1200 CU Plus"
@ -29,7 +27,7 @@
:model "BearPaw 1200 TA"
:interface "USB"
:status :beta
:comment "works, TA supported"
:comment "Transparency adapter supported"
:model "BearPaw 2400 CS"
:interface "USB"
@ -54,16 +52,15 @@
:model "BearPaw 2400 TA"
:interface "USB"
:status :beta
:comment "works, TA supported"
:comment "Transparency adapter supported"
:model "BearPaw 2400 TA Plus"
:interface "USB"
:status :beta
:comment "works, TA supported"
:comment "Transparency adapter supported"
:model "ScanExpress 1200 UB Plus"
:interface "USB"
:comment "works"
:status :beta
:model "ScanExpress A3 USB"
@ -85,60 +82,65 @@
:url "http://www.artecusa.com/"
:model "Ultima 2000"
:status :alpha
:status :beta
:interface "USB"
:comment "works, only product id 0x4002 is supported"
:model "Ultima 2000 e+"
:status :untested
:interface "USB"
:comment "Testers welcome"
:mfg "Boeder"
:model "Sm@rtScan Slim Edition"
:status :alpha
:status :beta
:interface "USB"
:comment "works, similar to Artec Ultima 2000"
:comment "similar to Artec Ultima 2000"
:mfg "Packard Bell"
:model "Diamond 1200"
:status :alpha
:status :beta
:interface "USB"
:comment "works, similar to Mustek BearPaw 1200 Plus"
:comment "similar to Mustek BearPaw 1200 Plus"
:mfg "Medion/Lifetec/Tevion/Cytron"
:url "http://www.medion.com"
:comment "Sold by Aldi and Tchibo"
:model "LT 9452"
:status :alpha
:status :beta
:interface "USB"
:comment "works"
:comment "Simlar to Mustek ScanExpress 1200 UB Plus"
:model "MD/LT 9385"
:status :alpha
:status :beta
:interface "USB"
:comment "works"
:comment "Similar to Artec Ultima 2000"
:model "MD 9458"
:status :alpha
:status :beta
:interface "USB"
:comment "works"
:comment "Similar to Artec Ultima 2000 (e+?)"
:mfg "Trust"
:url "http://www.trust-site.com"
:model "Flat Scan USB 19200"
:status :untested
:status :beta
:interface "USB"
:comment "Contact author if you own such a model"
:comment "Similar to Artec Ultima 2000"
:model "Compact Scan USB 19200"
:status :alpha
:interface "USB"
:comment "works, if you have vendor id 0x055f and product id 0x0006, use the mustek_usb backend instead "
:comment "works, if you have vendor id 0x055f and product id 0x0006, use the mustek_usb backend instead, similar to Mustek ScanExpress 1200 UB (Plus)"
:mfg "Lexmark"
:url "http://www.lexmark.com/"
:model "X70"
:status :alpha
:interface "USB"
:comment "works up to 600 dpi"
:comment "works in all resolutions but 50 and 1200 dpi"
:model "X73"
:status :untested

224
doc/sane-gt68xx.man 100644
Wyświetl plik

@ -0,0 +1,224 @@
.TH sane-gt68xx 5 "25 Oct 2002"
.IX sane-gt68xx
.SH NAME
sane-gt68xx - SANE backend for GT-68XX based USB flatbed scanners
.SH DESCRIPTION
The
.B sane-gt68xx
library implements a SANE (Scanner Access Now Easy) backend that provides
access to USB flatbed scanners based on the Grandtech GT-6801 and GT-6816
chips. At present, the following scanners are known to work with this
backend:
.PP
.RS
Artec Ultima 2000 (only product 0x4002)
.br
Boeder SmartScan Slim Edition
.br
Lexmark X70
.br
Medion/Lifetec/Tevion/Cytron MD/LT 9385
.br
Medion/Lifetec/Tevion LT 9452
.br
Medion/Lifetec/Tevion MD 9458
.br
Mustek BearPaw 1200 CS
.br
Mustek BearPaw 1200 CU
.br
Mustek BearPaw 1200 TA
.br
Mustek BearPaw 2400 CU (Plus)
.br
Mustek BearPaw 2400 TA (Plus)
.br
Mustek ScanExpress 1200 UB Plus
.br
Packard Bell Diamond 1200
.br
Trust Compact Scan USB 19200
.br
Trust Flat Scan USB 19200
.RE
.PP
More details can be found on the gt68xx backend homepage
.IR http://www.meier-geinitz.de/sane/gt68xx/ .
.PP
This is ALPHA software. Keep your hand at the scanner's plug and unplug it, if
the head bumps at the end of the scan area.
.PP
If you own a scanner other than the ones listed above that works with this
backend, please let me know this by sending the scanner's exact model name and
the USB vendor and device ids (e.g. from /proc/bus/usb/devices,
sane-find-scanner or syslog) to me. Even if the scanner's name is only
slightly different from the models mentioned above, please let me know.
.PP
.SH KERNEL ISSUES
If libusb-0.1.6 or later is installed, this section can be skipped. The
scanner should be found by sane-find-scanner without further actions. For
setting permissions and general USB information looks at sane-usb(5).
.PP
The scanners based on the GT-6816 (Mustek BearPaw TA and BearPaw Plus models,
the Packard Bell and the Lexmark scanner) need a Linux kernel 2.4.12 or newer.
Recent 2.2 kernels may also work, but I haven't tested them.
.PP
The scanners based on the GT-6801 (all other scanners) need an updated kernel
scanner module that is not yet included in the official kernel code. It can
be downloaded from the gt68xx backend homepage. There is also an installation
instruction.
.SH FIRMWARE FILE
You need a firmware file for your scanner. That's a small file containing
software that will be uploaded to the scanner's memory. It's usually named
*.usb, e.g. PS1fw.usb. It comes on the installation CD that was provided by
the manufacturer, but it may be packaged together with the installation
program in an .exe file. For Mustek scanners, the file can be dowloaded from
the gt68xx backend homepage. For other scanners, check the CD for .usb
files. If everything else fails, you must install the Windows driver and get
the firmware from there (usually in the windows/system or system32
directories). Put that firmware file into @DATADIR@/sane/gt68xx/.
.SH CONFIGURATION
The contents of the
.I gt68xx.conf
file is a list of usb lines containing vendor and product ids that correspond
to USB scanners. The file can also contain option lines. Empty lines and
lines starting with a hash mark (#) are ignored. The scanners are
autodetected by
.I usb vendor_id product_id
statements which are already included into
.IR gt68xx.conf .
"vendor_id" and "product_id" are hexadecimal numbers that identfy the
scanner.
.PP
The
.IR override ,
.IR firmware ,
.IR vendor ,
and
.I model
options must be placed after the
.I usb
line they refer to.
.PP
Option
.I override
is used to override the default model parameters. That's necessary for some
scanners that use the same vendor/product ids but are different. For these
scanners there are already commented out override lines in the configuration
file.
.I override "mustek-scanexpress-1200-ub-plus"
is necessary for the Mustek Scanexpress 1200 UB Plus, the
Medion/Lifetec/Tevion LT 9452, and the Trust Compact Scan USB 19200.
.I override "artec-ultima-2000"
is used for the Artec Ultima 2000, the Boeder SmartScan Slim Edition, the
Medion/ Lifetec/ Tevion/ Cytron MD/LT 9385, the Medion/ Lifetec/ Tevion MD
9458, and the Trust Flat Scan USB 19200.
.I override "mustek-bearpaw-2400-cu"
is necessary for the Mustek BearPaw 2400 CU.
.PP
Option
.I firmware
selects the name and path of the firmware file. It's only necessary if the
default (or override) doesn't work. The default firmware directory is
@DATADIR@/sane/gt68xx/. You may need to create this directory. If you
want to place the firmware files at a different path, use a
.I firmware
line.
.PP
The
.I vendor
and
.I model
options are not absolutely necessary but for convenience. Quite a lot of
scanners from different manufacturers share the same vendor/product ids so you
can set the "correct" name here.
.PP
A sample configuration file is shown below:
.PP
.RS
usb 0x05d8 0x4002
.br
override "mustek-scanexpress-1200-ub-plus"
.br
firmware "/opt/gt68xx/SBfw.usb"
.br
vendor "Trust"
.br
product "Compact Scan USB 19200"
.RE
.SH FILES
.TP
.I @CONFIGDIR@/gt68xx.conf
The backend configuration file (see also description of
.B SANE_CONFIG_DIR
below).
.TP
.I @LIBDIR@/libsane-gt68xx.a
The static library implementing this backend.
.TP
.I @LIBDIR@/libsane-gt68xx.so
The shared library implementing this backend (present on systems that
support dynamic loading).
.SH ENVIRONMENT
.TP
.B SANE_CONFIG_DIR
This environment variable specifies the list of directories that may
contain the configuration file. Under UNIX, the directories are
separated by a colon (`:'), under OS/2, they are separated by a
semi-colon (`;'). If this variable is not set, the configuration file
is searched in two default directories: first, the current working
directory (".") and then in @CONFIGDIR@. If the value of the
environment variable ends with the directory separator character, then
the default directories are searched after the explicitly specified
directories. For example, setting
.B SANE_CONFIG_DIR
to "/tmp/config:" would result in directories "tmp/config", ".", and
"@CONFIGDIR@" being searched (in this order).
.TP
.B SANE_DEBUG_GT68XX
If the library was compiled with debug support enabled, this
environment variable controls the debug level for this backend. Higher
debug levels increase the verbosity of the output.
Example:
export SANE_DEBUG_GT68XX=4
.SH "SEE ALSO"
sane(7), sane-usb(5)
.br
@DOCDIR@/gt68xx/gt68xx.CHANGES
.SH AUTHOR
Henning Meier-Geinitz <henning@meier-geinitz.de>
.br
The original gt68xx driver was written by Sergey Vlasov, Andreas Nowack, and
David Stevenson. Thanks for sending patches and answering questions to them
and all the other contributors.
.SH BUGS
Currently scanning seems to only work under Linux. With the BSDs, either the
first command after the firmware boot or the reading of the scanned data times
out.
.PP
Automatic gain is slow (especially 2400 CU). Maybe use the existing default
values. Also, default values could be added to gt68xx.conf. Check if auto-gain
for CCD scanners should use the max/min values, too.
.PP
The first few lines of the image are garbage for the 2400 TA
Plus.
.PP
The images are too dark for some scanners, especially in TA mode. Maybe
add a gamma option?
.PP
Interpolation should be used instead of just copying data, when the X- and
Y-resolution differ.
.PP
Support for buttons is missing.
.PP
More detailed bug information is
available at the gt68xx backend homepage
.IR http://www.meier-geinitz.de/sane/gt68xx .
Please contact me if you find a bug or missing feature:
<henning@meier-geinitz.de>

Wyświetl plik

@ -1,4 +1,4 @@
.TH sane 7 "July 25th, 2002"
.TH sane 7 "Oct 24th, 2002"
.IX sane
.SH NAME
@ -96,6 +96,7 @@ compiling and installing SANE.
.TP
.B SCSI configuration
For information about various systems and SCSI controllers see sane-scsi(5).
.TP
.B USB configuration
For information about USB configuration see sane-usb(5).
@ -177,6 +178,11 @@ flatbed scanners. See sane-epson(5) for details.
The fujitsu backend provides support for Fujitsu 3091, 3093, 3096 and
fi-4340 SCSI scanners. See sane-fujitsu(5) for details.
.TP
.B gt68xx
The gt68xx backend provides support scanners based on the Grandtech GT-6801
and GT-6816 chips like the Artec Ultima 2000 and several Mustek BearPaw CU and
TA models. See sane-gt68xx(5) for details.
.TP
.B hp
The SANE hp backend provides access to HP ScanJet scanners and OfficeJet
multi-function peripherals (MFPs) which support SCL (Scanner Control Language
@ -211,9 +217,8 @@ The mustek_pp backend provides access to Mustek parallel port flatbed
scanners. See sane-mustek_pp(5) for details.
.TP
.B mustek_usb
The mustek_usb backend provides access to some Mustek USB flatbed
scanners. Some Mustek BearPaw scanners are supported by the plustek backend,
however. See sane-mustek_usb(5) for details.
The mustek_usb backend provides access to some Mustek ScanExpress USB flatbed
scanners. See sane-mustek_usb(5) for details.
.TP
.B nec
The SANE nec backend supports the NEC PC-IN500/4C SCSI scanner. See