summaryrefslogtreecommitdiff
path: root/doc/sane-microtek.man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sane-microtek.man')
-rw-r--r--doc/sane-microtek.man194
1 files changed, 194 insertions, 0 deletions
diff --git a/doc/sane-microtek.man b/doc/sane-microtek.man
new file mode 100644
index 0000000..84047dc
--- /dev/null
+++ b/doc/sane-microtek.man
@@ -0,0 +1,194 @@
+.TH sane\-microtek 5 "13 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
+.IX sane\-microtek
+.SH NAME
+sane\-microtek \- SANE backend for Microtek scanners
+.SH DESCRIPTION
+The
+.B sane\-microtek
+library implements a SANE (Scanner Access Now Easy) backend that
+provides access to the "second generation" Microtek scanners. At present,
+the following hardware is known to work with this backend:
+.PP
+.RS
+Microtek ScanMaker E2, E3, E6
+.br
+Microtek ScanMaker II, IIG, IIHR, IISP, III
+.br
+Microtek ScanMaker 35t, 35t+, 45t
+.br
+Microtek ScanMaker 600GS, 600ZS (see bug notes)
+.br
+Agfa StudioScan
+.br
+Agfa StudioScan II, StudioScan IIsi
+.br
+Agfa Arcus II (but not the "Arcus")
+.br
+Agfa DuoScan (preliminary)
+.br
+Vobis "Highscreen Realscan"
+.br
+Microtek Color PageWiz (preliminary)
+.br
+.PP
+Transparent Media Adapter
+.br
+Document AutoFeeder
+.br
+.RE
+.PP
+The driver supports line art, halftone, 8bpp gray, and 24bpp color scans
+at normal and "expanded" resolutions (i.e. 1200x1200 on an E6), fast scans
+for color previews, and downloadable gamma tables.
+.PP
+The supported scanners are all SCSI scanners. However, some parallel
+port models may work (under Linux), if they use a parport->scsi chip,
+and if you can find a scsi->parport driver. This is known to be the
+case for the Color PageWiz.
+.PP
+The driver does
+.B not
+support the newest Microtek scanners, such as the V330 and V660, which use
+a new and very different SCSI-II command set. For those, try the alternate
+.B microtek2
+backend. Most non-SCSI scanners would use the new command set. Most
+scanners newer than the Scanmaker E6 would use the new command set.
+.PP
+If you own a Microtek scanner other than the ones listed above, tell us
+what happens --- see the
+.BR BUGS
+section at the end of this document.
+.PP
+Although this manual page is generally updated with each release,
+up-to-date information on new releases and extraneous helpful hints
+are available from the backend homepage:
+.br
+.RS
+.B http://www.mir.com/mtek/
+.RE
+
+.SH "DEVICE NAMES"
+This backend expects device names of the form:
+.PP
+.RS
+.I special
+.RE
+.PP
+Where
+.I special
+is the UNIX path-name for the special device that corresponds to the
+scanner. The special device name must be a generic SCSI device or a
+symlink to such a device. Under Linux, such a device name could be
+.I /dev/sga
+or
+.IR /dev/sge ,
+for example.
+.PP
+
+.SH CONFIGURATION
+The contents of the
+.I microtek.conf
+file is a list of device names that correspond to Microtek
+scanners. Empty lines and lines starting with a hash mark (#) are
+ignored. A sample configuration file is shown below:
+.PP
+.RS
+/dev/scanner
+.br
+# this is a comment
+.br
+/dev/sge
+.RE
+.PP
+The configuration file may also contain the special tokens
+.I norealcal
+or
+.I noprecal.
+.I norealcal
+will disable the use of magic, undocumented scanner calibration commands
+which are known to work on the E6, but may not work with other models.
+.I noprecal
+will disable logic which tries to avoid scanner precalibration. This logic
+would only have been activated if the magic calibration code was turned off.
+
+.PP
+.SH FILES
+.TP
+.I @CONFIGDIR@/microtek.conf
+The backend configuration file (see also description of
+.B SANE_CONFIG_DIR
+below).
+.TP
+.I @LIBDIR@/libsane\-microtek.a
+The static library implementing this backend.
+.TP
+.I @LIBDIR@/libsane\-microtek.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_MICROTEK
+If the library was compiled with debugging support enabled, this
+environment variable controls the debug level for this backend.
+A value of 128 requests maximally copious debug output; smaller
+levels reduce verbosity.
+
+.SH "SEE ALSO"
+sane(7), sane\-scsi(5)
+
+.SH AUTHOR
+Matt Marjanovic
+
+.SH BUGS
+Known bugs/limitations are:
+.PP
+.RS
+Brightness and contrast broken.
+.br
+The 600GS is grayscale only, and will lock up if you select color.
+(Unfortunately, the 600GS and 600ZS are indistinguishable by software.)
+.br
+.RE
+.PP
+i.e. don't complain about these --- but if brightness and/or contrast
+.B do
+work for you, please tell me.
+.PP
+If your scanner locks up, try setting the
+.I norealcal
+or
+.I noprecal
+option in the configuration file (first one, then both), and see if it helps.
+(If it does, report it.)
+.PP
+Send lengthy bug reports and new scanner information to
+.BR mtek\-bugs@mir.com .
+All bug reports and new scanner inquiries should include an error log file.
+You can generate copious
+stderr output by setting the SANE_DEBUG_MICROTEK environment variable
+described above. For example:
+.PP
+.RS
+setenv SANE_DEBUG_MICROTEK 128
+.RE
+.PP
+More general comments, suggestions, and inquiries about frontends
+or SANE should go to
+.BR sane\-devel@lists.alioth.debian.org ,
+the SANE Developers mailing list. Have a look at
+http://www.sane\-project.org/mailing\-lists.html concerning subscription to sane\-devel.