From 47d5a76da03661aa0aaae870e3ce60324cb18777 Mon Sep 17 00:00:00 2001 From: Henning Geinitz Date: Mon, 24 Feb 2003 21:05:18 +0000 Subject: [PATCH] Added documentation for ma1509 backend. --- ChangeLog | 2 + doc/Makefile.in | 6 +- doc/descriptions/ma1509.desc | 39 ++++++++++ doc/sane-ma1509.man | 134 +++++++++++++++++++++++++++++++++++ doc/sane.man | 7 +- 5 files changed, 185 insertions(+), 3 deletions(-) create mode 100644 doc/descriptions/ma1509.desc create mode 100644 doc/sane-ma1509.man diff --git a/ChangeLog b/ChangeLog index 1a6981232..3606a23ff 100644 --- a/ChangeLog +++ b/ChangeLog @@ -3,6 +3,8 @@ * backend/Makefile.in backend/dll.conf backend/ma1509.c backend/ma1509.conf backend/ma1509.h: Added new backend ma1509 for Mustek BearPaw 1200F scanners. + * doc/Makefile.in doc/descriptions/ma1509.desc doc/sane-ma1509.man + doc/sane.man doc/.cvsignore: Added documentation for ma1509 backend. 2003-02-23 Simon Munton * backend/pie.c: increment BUILD (was missed in last change) diff --git a/doc/Makefile.in b/doc/Makefile.in index 03151d04f..812443f62 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -50,7 +50,8 @@ 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-gt68xx.5 sane-artec_eplus48u.5 + sane-coolscan2.5 sane-hpsj5s.5 sane-gt68xx.5 sane-artec_eplus48u.5 \ + sane-ma1509.5 SECT7 = sane.7 MANPAGES = $(SECT1) $(SECT5) $(SECT7) READMES = README AUTHORS COPYING ChangeLog LICENSE NEWS PROBLEMS \ @@ -88,7 +89,8 @@ DISTFILES = Makefile.in backend-writing.txt descriptions.txt \ sane-umax_pp.man sane-usb.man sane-v4l.man sane.man sane.png \ sane.tex saned.man scanimage.man sane-sceptre.man sane-canon_pp.man \ sane-teco1.man sane-teco2.man sane-teco3.man sane-test.man sane-sp15c.man \ - sane-hpsj5s.man gamma4scanimage.man sane-gt68xx.man sane-artec_eplus48u.man + sane-hpsj5s.man gamma4scanimage.man sane-gt68xx.man sane-artec_eplus48u.man \ + sane-ma1509.man .PHONY: all clean depend dist distclean html html-man install \ install-mostang sane-html uninstall diff --git a/doc/descriptions/ma1509.desc b/doc/descriptions/ma1509.desc new file mode 100644 index 000000000..0c9783d68 --- /dev/null +++ b/doc/descriptions/ma1509.desc @@ -0,0 +1,39 @@ +; SANE Backend specification file +; +; It's basically emacs-lisp --- so ";" indicates comment to end of line. +; All syntactic elements are keyword tokens, followed by a string or +; keyword argument, as specified. +; +; ":backend" *must* be specified. +; All other information is optional (but what good is the file without it?). +; + +:backend "ma1509" ; name of backend +:version "1.0-2" ; version of backend +:status :alpha ; :alpha, :beta, :stable, :new +:manpage "sane-ma1509" ; name of manpage (if it exists) +:url "http://www.meier-geinitz.de/sane/ma1509-backend/" ; backend's web page + +:devicetype :scanner ; start of a list of devices.... + ; other types: :stillcam, :vidcam, + ; :meta, :api + +:mfg "Mustek" ; name a manufacturer +:url "http://www.mustek.com/" +:url "http://www.mustek.com.tw/" +:url "http://www.mustek.de/" + +:model "BearPaw 1200 F" ; name models for above-specified mfg. +:interface "USB" ; interface type of the device: + ; "SCSI", "USB", "Parport (EPP)", + ; "Parport (SPP)", "Parport (ECP)", + ; "Serial port" or "Propretiary". +:status :alpha +:comment "Works upto 600 dpi. No support for TA and ADF yet." + + +; :comment and :url specifiers are optional after :mfg, :model, :desc, +; and at the top-level. + + + diff --git a/doc/sane-ma1509.man b/doc/sane-ma1509.man new file mode 100644 index 000000000..26b83b77b --- /dev/null +++ b/doc/sane-ma1509.man @@ -0,0 +1,134 @@ +.TH sane-ma1509 5 "24 Feb 2003" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.IX sane-ma1509 +.SH NAME +sane-ma1509 \- SANE backend for Mustek BearPaw 1200F USB scanner +.SH DESCRIPTION +The +.B sane-ma1509 +library implements a SANE (Scanner Access Now Easy) backend that provides +access to the Mustek BearPaw 1200F USB flatbed scanner. This scanner is based +on the MA-1509 chipset. Other scanners that use this chip (if they exist) may +also work. +.PP +This backend is ALPHA software. Be careful and remove the power plug +immediately if your hear unusual noises. +.PP +More details can be found on the ma1509 backend homepage +.IR http://www.meier-geinitz.de/sane/ma1509-backend/ . +.PP +Other Mustek USB scanners are supported by the gt68xx, mustek_usb and the +plustek backends. See +.BR sane-mustek_usb (5), +.BR sane-gt68xx (5) +and +.BR sane-plustek (5) +for details. +.PP +This backend can only work with scanners that are already detected by the +operating system. See +.BR sane-usb (5) +for details. +.PP +If you own a scanner other than the Mustek BearPaw 1200F 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 +.I /proc/bus/usb/devices +or syslog) to me. + +.SH "DEVICE NAMES" +This backend expects device names of the form: +.PP +.RS +.I special +.RE +.PP +Where +.I special +is a path-name for the special device that corresponds to a USB scanner. +With Linux, such a device name could be +.I /dev/usb/scanner0 +or +.IR libusb:001:002 , +for example. +.PP + +.SH CONFIGURATION +The contents of the +.I ma1509.conf +file is a list of options and device names that correspond to Mustek BearPAw +1200F scanners. Empty lines and lines starting with a hash mark (#) are +ignored. +.PP +Instead of using the device name, the scanner can be autodetected by +.B "usb vendor_id product_id" +statements which are already included into +.IR ma1509.conf . +This is only supported with Linux 2.4.8 and higher and all systems that +support libsub. "vendor_id" and "product_id" are hexadecimal numbers that +identfy the scanner. If this doesn't work, a device name must be placed in +.I ma1509.conf +as described above. +.PP +To set the time the lamp needs for warm-up, use +.B option +.B warmup-time +in +.IR ma1509.conf . +The time is given in seconds after the option. The default is 30 seconds. +.SH FILES +.TP +.I @CONFIGDIR@/ma1509.conf +The backend configuration file (see also description of +.B SANE_CONFIG_DIR +below). +.TP +.I @LIBDIR@/libsane-ma1509.a +The static library implementing this backend. +.TP +.I @LIBDIR@/libsane-ma1509.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_MA1509 +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. + +.SH "SEE ALSO" +.BR sane (7), +.BR sane-usb (5), +.BR sane-gt68xx (5), +.BR sane-plustek (5), +.BR sane-mustek_usb (5), +.BR sane-mustek (5), +.BR sane-mustek_pp (5), +.br +.I http://www.meier-geinitz.de/sane/ma1509-backend/ + +.SH AUTHOR +Henning Meier-Geinitz + +.SH BUGS +Resolutions higher than 600 dpi don't work +.br +Transparency adapter and automatic document feeder is not supported yet +.br +No support for "high-speed" mode (jpeg) +.PP +More detailed bug information is available at the MA-1509 backend homepage +.IR http://www.meier-geinitz.de/sane/ma1509-backend/ . diff --git a/doc/sane.man b/doc/sane.man index 5d271f9aa..d7c1db368 100644 --- a/doc/sane.man +++ b/doc/sane.man @@ -1,4 +1,4 @@ -.TH sane 7 "Nov 22th, 2002" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.TH sane 7 "Feb 24th, 2003" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" .IX sane .SH NAME @@ -279,6 +279,11 @@ LEO FS-1130 scanner. See .BR sane-leo (5) for details. .TP +.B ma1509 +The ma1509 backend supports the Mustek BearPaw 1200F USB flatbed scanner. See +.BR sane-ma1509 (5) +for details. +.TP .B matsushita This backend supports some Panasonic KVSS high speed scanners. See .BR sane-matsushita (5)