diff options
Diffstat (limited to 'doc/sane-umax_pp.man')
| -rw-r--r-- | doc/sane-umax_pp.man | 302 |
1 files changed, 302 insertions, 0 deletions
diff --git a/doc/sane-umax_pp.man b/doc/sane-umax_pp.man new file mode 100644 index 0000000..2a8349d --- /dev/null +++ b/doc/sane-umax_pp.man @@ -0,0 +1,302 @@ +.TH "sane\-umax_pp" "5" "14 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.IX sane\-umax_pp +.SH "NAME" +sane\-umax_pp \- SANE backend for Umax Astra parallel port flatbed scanners +.SH "DESCRIPTION" +The +.B sane\-umax_pp +library implements a SANE (Scanner Access Now Easy) backend that +provides access to Umax parallel port flatbed scanners. The +following scanners work with this backend: +.PP +.RS +Model: +.br +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.br +Astra 610P +.br +Astra 1220P +.br +HP3200C +.br +Astra 1600P +.br +Astra 2000P +.br +Genius ColorPage-Life Pro +.br +.RE +.PP +This backend handles 75x75, 150x150, 300x300, 600x600 and 600x1200 for 1220P/1600P/2000P +dpi scan resolutions, and 75x75, 150x150, 300x300 and 300x600 for 610P. In color and gray +levels, there is a software lineart mode. +.PP +The new generation models share a newer version of the 610P ASIC embedded in an EPAT chip. +Only parts such as CCD and ADC change from +one to another. They even all reports being UMAX Astra 1220P via IEEE1284. +There isn't software way to recognize them properly. Under windows, model is +set by the driver installed, regardless of the hardware. +.PP +.TP +.B EPP/ECP MODES ONLY +The current version of the backend uses only EPP or ECP mode to communicate +with the scanner. PS/2 mode isn't implemented. The 610P only use SPP. It is +recommended that you set your parallel port to EPP in BIOS with the current +version of this +backend. You can leave it to ECP or ECP+EPP, but in this case you may not use +ppdev but only direct hardware access if you have to use ECP. ECPEPP will only +work if you use a 2.4 or 2.6 kernel with ppdev character device support. +.PP +This backend does support parport sharing only +.I +if you have a kernel with ppdev support. +.I +.PP +Note that if you don't use the ppdev character device, the backend +needs to run as root. To allow user access to the scanner +run the backend through the network interface (See saned(8) and sane\-net(5)). +A more relaxed solution (security wise) is to add suid bit to the frontend +(See chmod(1)). +The backend drop root priviledges as soon as it can, right after gaining direct +access to IO ports, which lessen risks when being root. + +.SH "DEVICE NAMES" +This backend expects device names of the form: +.PP +.RS +.I port value +.RE +.PP +Where +\fBvalue\fR is : + +.RS +.TP +auto +autodetect all parallel ports and probe +them for scanner +.TP +safe\-auto +autodetect all parallel ports and probe +them for scanner, but does not try direct +hardware access +.TP +/dev/ppi0 +uses *BSD ppi device, depending on the +number of available parallel port, you +have to use /dev/ppi1, /dev/ppi2, ... +.TP +/dev/parport0 +uses linux ppdev device, depending on the +number of available parallel port, you +have to use /dev/parport1, /dev/parport2, ... +.TP +0x378 +does direct hardware access on the given +address. Usual values are 0x378, 0x278, 0x3BC +In this case, you have to run the scanner as +root (*BSD and linux), or with 'IOPL=yes' on +OS/2 +.PP +.RE +\fBNOTE:\fR in all cases, you must have sufficient priviledges +to get access to the chosen device or address. Depending on the +security settings, devices may not be available for all users. +You have to change permissions on the dev/ppi* or /dev/parport* devices. +.PP +.RE +You can rename any device using the +.PP +.RS +.I name devname +.br +.I model model +.br +.I vendor vendor +.RE +.PP +options. These options apply to the last port option. + +.SH "CONFIGURATION" +Please make sure to edit umax_pp.conf +.B before +you use the backend. +.PP +The contents of the +.B umax_pp.conf +file is a list of options and device names that correspond to Umax +scanners. Empty lines and lines starting with a hash mark (#) are +ignored. +.PP +The eight options supported are +.BR red\-gain , +.BR green\-gain , +.BR blue\-gain , +.BR red\-offset , +.BR green\-offset , +.BR blue\-offset , +.BR astra , +and +.BR buffer . + +Options +.B red\-gain +, +.B green\-gain +and +.B blue\-gain +allow you to adjust the sensitivity of your scanner for the given color. Values +range from 0 (lowest gain) to 15 (highest). If the advanced option "Gain" isn't +checked in the frontend, the backend does automatic gain calibration, and do not use +user provided values. + +.PP + +Options +.B red\-offset +, +.B green\-offset +and +.B blue\-offset +allow you to adjust the offset of your scanner for the given color. Values +range from 0 (lowest offset) to 15 (highest). +.PP + +Option +.B astra +allows you to change the model of your scanner. Current auto detection is based +on side effects on scanning when using 1220P command set on other models, so +it may fail on unknown hardware combination. Valid values are 610, 1220, 1600 +and 2000. It is useful only when autodetection fails to detect properly +your scanner model. If your scanner work properly but is reported wrongly, +let it be that way. +The only valid case to change the model is when your scanner produces "black" or +"inverted" scans. In this case you can put the model. Be aware that it will +prevent scanner model autodetection. +.PP + +Option +.B buffer +allows you to change the size of the scan buffer. The size must be specified in +bytes. The default value is 2 megabytes. Decreasing this value will improve the +smoothness of progress bar in the frontend, but will stall the +scan more often. + +.PP + + + +.SH "FILES" +.TP +.I @CONFIGDIR@/umax_pp.conf +The backend configuration file (see also description of +.B SANE_CONFIG_DIR +below). +.TP +.I @LIBDIR@/libsane\-umax_pp.a +The static library implementing this backend. +.TP +.I @LIBDIR@/libsane\-umax_pp.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_UMAX_PP +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 +levels reduce verbosity. + +.PP +.RS +.ft CR +.nf +level debug output +\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + 0 nothing + 1 errors + 2 warnings & minor errors + 3 additional information + 4 debug information + 5 code flow (not supported yet) + 6 special debug information +.fi +.ft R +.RE +.PP +.TP +.B SANE_DEBUG_UMAX_PP_LOW +This variable sets the debug level for the SANE interface for the Umax +ASIC. Note that enabling this will spam your terminal with some +million lines of debug output. + +.PP +.RS +.ft CR +.nf +level debug output +\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + 0 nothing + 1 errors + 8 command blocks + 16 detailed code flow + 32 dump datafiles + 255 everything +.fi +.ft R +.RE +.PP + +.PP +.SH "SEE ALSO" +sane(7), sane\-net(5), saned(8) + +.TP +For latest bug fixes and information see +.I http://umax1220p.sourceforge.net/ + +.SH "AUTHOR" +St\['e]phane Voltz <stef.dev@free.fr> + +.SH "CREDITS" +Support for the 610P has been made possible thank to an hardware donation +by William Stuart. + +.SH "BUG REPORTS" +If something doesn't work, please contact me. But I need some information about +your scanner to be able to help you... + +.TP +.I SANE version +run "scanimage \-V" to determine this +.TP +.I the backend version and your scanner hardware +run "SANE_DEBUG_UMAX_PP=255 scanimage \-L 2>log" as root. If you don't get any output +from the umax_pp backend, make sure a line "umax_pp" is included into +your @CONFIGDIR@/dll.conf. +If your scanner isn't detected, make sure you've defined the right port address, or the +correct device +in your umax_pp.conf. +.TP +.I the name of your scanner/vendor +also a worthy information. Please also include the optical resolution and lamp type of your scanner, both can be found in the manual of your scanner. +.TP +.I any further comments +if you have comments about the documentation (what could be done better), or you +think I should know something, please include it. |