diff --git a/doc/sane-microtek2.man b/doc/sane-microtek2.man index 83b5713f6..aa8ff3ed2 100644 --- a/doc/sane-microtek2.man +++ b/doc/sane-microtek2.man @@ -1,5 +1,7 @@ -.TH sane-microtek2 5 "06 Nov 1998" -.IX sane-microtek2 +. .IX sane-microtek2 +." Process this file with +." groff -man -Tascii sane-microtek2 +.TH sane-microtek2 5 "19 May 2001" .SH NAME sane-microtek2 - SANE backend for Microtek scanners with SCSI-2 command set .SH DESCRIPTION @@ -7,170 +9,299 @@ The .B sane-microtek2 library implements a SANE (Scanner Access Now Easy) backend that provides access to some Microtek scanners with a SCSI-2 command set. -This backend should be considered alpha. +This backend can be considered alpha. Some scanner models are reported to work +well, others not. .PP -There exists a different backend for Microtek scanners with SCSI-1 -command set. Refer to sane-microtek(5) for details. +There exists a different backend for Microtek scanners with SCSI-1 command +set. +Refer to sane-microtek(5) for details. .PP -At present, the following -scanners are known positively to work with this backend: +And there is work in progress for the ScanMaker 3600. +See http://sourceforge.net/projects/sm3600 .PP -.RS -Vendor Product id: Remark: +At present, the following scanners are known positively to work with this +backend: +.PP +Vendor Product id: Remark +.br +-------- -------------- ------------- +.br +Microtek E3+ Parport and SCSI +.br +Microtek X6 SCSI +.br +Microtek X6EL SCSI +.br +Microtek X6USB USB +.br +Microtek ScanMaker V300 Parport and SCSI +.br +Microtek ScanMaker V310 Parport and SCSI +.br +Microtek ScanMaker V600 Parport and SCSI +.br +Microtek ScanMaker 330 SCSI +.br +Microtek ScanMaker 630 SCSI +.br +Microtek ScanMaker 636 SCSI +.br +Microtek ScanMaker 9600XL SCSI; only flatbed mode? +.br +Microtek Phantom 330CX Parport .br --------- -------------- ----------- -.br -Microtek E3plus all modes ok -.br -Microtek X6 all modes ok -.br -Microtek ScanMaker 330 all modes ok -.br -Microtek ScanMaker 630 all modes ok -.br -Microtek ScanMaker 636 all modes ok -.br -Microtek Phantom 636 all modes ok -.br -Vobis HighScan all modes ok -.RE -.PP -If you own a Microtek scanner with SCSI-2 interface other than the ones -listed above, it may or may not work with SANE! +Microtek SlimScan C3 Parport +.br +Microtek Phantom 636 SCSI +.br +Microtek Phantom 636CX Parport +.br +Microtek V6USL SCSI (and USB ???) +.br +Vobis HighScan SCSI (E3+ based models) +.br +Scanport? SQ300 Parport? +.br +Scanpaq SQ2030 Parport +.PP +Additional information can be found at +.B www.mostang.com/sane/ +. +If you own a Microtek scanner with SCSI-2 interface other than the ones +listed +above, it may or may not work with SANE! Because equal scanners are sold under +different names in different countries your model may be equivalent to one of +the above. +.PP +The parport scanners work with the ppscsi + onscsi kernel modules. +.PP +If you try your scanner for the first time keep an eye on it. If it gets +commands that it doesn't understand the scanhead may go beyond the scan area. +The scanner then makes strange noises. In this case immedieately switch off +the scanner or disconnect its power cable to prevent damages! +.PP +If your scanner is a different one than the models mentioned above and it is +working please tell the author about it. It would be nice if you add a logfile +to this information (creation of the logfile: see below). +.PP +If your scanner is not working properly you also should create a logfile and +send it to the author. He will use the information to improve the backend and +possibly make your scanner work. +.PP +.br +How to create the logfile? +.TP +- put the line +.br +"option dump 2" into your +.I microtek2.conf + file or change the existing "option dump" to "2" +.TP +- in a terminal (bash) type +.br +"export SANE_DEBUG_MICROTEK2=30" and then +.br +"scanimage -l0 -t0 -x100 -y20 2>scan.log >sout.pnm" +.br +You get two files: scan.log contains the logfile and sout.pnm the scanned +image (if there was scanned something). Zip them before sending. .SH "FRONTEND OPTIONS" -This backend dynamically enables the options for the frontend, -that are supported by the scanner in dependence of the scanning-mode -and other options. Not supported options are disabled. -.PP +This backend dynamically enables the options for the frontend, that are +supported by the scanner in dependence of the scanning-mode and other +options. +Not supported options are disabled. +.PP The following options are supported by the Microtek2-driver: -.PP +.PP Color, grayscale, halftone and lineart scans. -.PP +.PP Highlight, midtone, shadow, contrast, brightness, exposure time control, -gamma correction, threshold (dependent of the scan mode) -.PP +gamma correction, threshold (dependent of the scan mode and the scanner +capabilities) +.PP Transparency media adapter, automatic document feeder +.PP +Additional options can be enabled or disabled in the +.I microtek2.conf +file. See the configuration section of this manpage. .SH "DEVICE NAMES" This backend expects device names of the form: -.PP +.PP .RS -.IR special +.I special .RE -.PP +.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 -.IR /dev/sga +.I /dev/sga or -.IR /dev/sge , +.I /dev/sge for example. -.SH CONFIGURATION +.SH "CONFIGURATION" The configuration file for this backend resides in -.IR @CONFIGDIR@/microtek2.conf . +.I @CONFIGDIR@/microtek2.conf +. Its contents is a list of device names that correspond to Microtek scanners with SCSI-2 interface. Empty lines and lines starting with a hash mark (#) are ignored. -.PP -The configuration file may also contain options. Currently two options are -supported: -.PP +.PP +The configuration file may also contain options. Global options that are valid +for all devices are placed above the device names. Device-specific options +are +placed under the device name. Currently the following options are supported: +.PP .RS option dump -.br +.br option strip-height +.br +option no-backtrack-option +.br +option lightlid-35 +.br +option toggle-lamp +.br +option lineart-autoadjust +.br +option backend-calibration .RE -.PP -If +.PP .I option dump -is enabled additional informations about the SCSI -commands that are sent to the scanner are printed to stderr. This option -is primarily useful for debugging purpose. -.PP +enables printing of additional information about the SCSI commands that are sent to +the scanner to stderr. This option is primarily useful for debugging purpose. +This option has to be a global option and is best placed at the top of the +.I microtek2.conf +file. +.PP If n=1 the contents of the command blocks and the results for the INQUIRY and READ SCANNER ATTRIBUTES command are printed to stderr. -.PP +.PP If n=2 the contents of the command blocks for all other SCSI commands are printed to stderr, too. If n=3 the contents of the gamma table is printed, too. If n=4 all scan data is additionally printed to stderr. -.PP +.PP The default is n=1. -.PP -The +.PP .I option strip-height , where is a floating point number, limits the amount of data that is read from the scanner with one read command. -The unit is inch and defaults to 1.0, -if this option is not set in the configuration file. If less than inch -of data fit into the SCSI buffer, then the smaller value is used and this -option has no effect. -.PP +The unit is inch and defaults to 1.0, if this option is not set in the +configuration file. If less than inch of data fit into the SCSI buffer, +then the smaller value is used and this option has no effect. +.PP If your system has a big SCSI buffer and you want to make use of the whole buffer, increase the value for . For example, if is set to 14.0, -no restrictions apply for scanners with a letter, legal or A4 sized -scan area. -.PP -At present the options apply to all devices in the configuration file and -cannnot be set on a per device basis. -.PP +no restrictions apply for scanners with a letter, legal or A4 sized scan area. +.PP +.PP +The following options enable or disable additional frontend options. If an +option is set to an appropriate option will appear in the frontend. +.PP +.I option no-backtrack-option +prevents the scanner head from moving backwards between the read commands. +This +speeds up scanning. Try it. +.PP +.I option lightlid-35 +If you use the LightLid-35 transparency adapter this option switches off the +flatbed lamp during the scan. +.PP +.I option toggle-lamp +You get a button in the frontend where you can switch on and off the flatbed +lamp. +.PP +.I option lineart-autoadjust +You can tell the backend to try to determine a good value for the lineart +threshold. +.PP +.I option backend-calibration +Some scanners (e.g. Phantom 330CX and 636CX) need to have calibrated the data +by the backend. Try this option if you see vertical stripes in your pictures. +.PP A sample configuration file is shown below: -.PP +.PP .RS option dump 1 -.br +.br option strip-height 1.0 -.br +.br /dev/scanner -.br +.br +option no-backtrack-option on +.br # this is a comment -.br +.br /dev/sge +.br +option lightlid-35 on .RE This backend also supports the new configuration file format which makes it easier to detect scanners under Linux. If you have only one scanner it -would be best to use the configuration file for this backend, that -is distributed with SANE. This file is shown below: -.PP +would be best to use the following configuration file for this backend: +.PP .RS option dump 1 -.br +.br option strip-height 14.0 -.br +.br +option no-backtrack-option on +.br +option backend-calibration on +.br +option lightlid-35 on +.br +option toggle-lamp on +.br +option lineart-autoadjust on +.br scsi * * Scanner .RE -In this case all SCSI-Scanners should be detected automatically. +In this case all SCSI-Scanners should be detected automatically because of the +.PP +scsi * * Scanner +.PP +line. -.SH FILES -.TP +.SH "FILES" +.TP .I @CONFIGDIR@/microtek2.conf The backend configuration file. -.TP +.TP .I @LIBDIR@/libsane-microtek2.a The static library implementing this backend. -.TP +.TP .I @LIBDIR@/libsane-microtek2.so The shared library implementing this backend (present on systems that support dynamic loading). -.SH ENVIRONMENT -.TP +.SH "ENVIRONMENT" +.TP .B SANE_DEBUG_MICROTEK2 If the library was compiled with debug support enabled, this environment variable controls the debug level for this backend. E.g., -a value of 128 requests all debug output to be printed. Smaller +a value of 255 requests all debug output to be printed. Smaller levels reduce verbosity. To see error messages on stderr set SANE_DEBUG_MICROTEK2 to 1 (Remark: The whole debugging levels should be better revised). -.br +.br E.g. just say: -.br +.br export SANE_DEBUG_MICROTEK2=128 .SH "SEE ALSO" -sane-scsi(5) -.SH AUTHOR -Bernd Schroeder +sane-scsi(5), sane(7) +.SH "AUTHORS" +Bernd Schroeder (not active anymore) +.br +Karsten Festag karsten.festag@t-online.de + + + + +