epsonds: documentation

2015-03-30 23:37:46 +02:00 · 2015-03-30 23:37:46 +02:00 · 9d196e8889
commit 9d196e8889
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@ -18,7 +18,7 @@ EXTRA_DIST = scanimage.man sane-config.man sane-find-scanner.man \
 # custom install/uninstall if we required man pages for every backend.
 BACKEND_MANS_ENABLED = @BACKEND_MANS_ENABLED@
 BACKEND_5MANS = sane-abaton.5 sane-agfafocus.5 sane-apple.5 sane-as6e.5 \
-	sane-dll.5 sane-dc25.5 sane-dmc.5 sane-epson.5 sane-epson2.5 \
+	sane-dll.5 sane-dc25.5 sane-dmc.5 sane-epson.5 sane-epson2.5 sane-epsonds.5 \
 	sane-hp.5 sane-gphoto2.5 sane-leo.5 sane-lexmark.5 \
 	sane-matsushita.5 sane-microtek.5 sane-microtek2.5 sane-mustek.5 \
 	sane-nec.5 sane-net.5 sane-pie.5 sane-pint.5 sane-pnm.5 \
@ -41,7 +41,7 @@ BACKEND_5MANS = sane-abaton.5 sane-agfafocus.5 sane-apple.5 sane-as6e.5 \

 EXTRA_DIST += sane-abaton.man sane-agfafocus.man sane-apple.man sane-as6e.man \
 	sane-dll.man sane-dc25.man sane-dmc.man sane-epson.man \
-	sane-epson2.man sane-hp.man sane-gphoto2.man sane-leo.man \
+	sane-epson2.man sane-epsonds.man sane-hp.man sane-gphoto2.man sane-leo.man \
 	sane-lexmark.man sane-matsushita.man sane-microtek.man \
 	sane-microtek2.man sane-mustek.man sane-nec.man sane-net.man \
 	sane-pie.man sane-pint.man sane-pnm.man sane-umax.man \
@ -169,6 +169,7 @@ DESC_FILES = descriptions/abaton.desc descriptions/agfafocus.desc \
  descriptions/dc210.desc descriptions/dc240.desc descriptions/dc25.desc \
  descriptions/dell1600n_net.desc descriptions/dll.desc descriptions/dmc.desc \
  descriptions/epjitsu.desc descriptions/epson2.desc descriptions/epson.desc \
+  descriptions/epsonds.desc \
  descriptions/fujitsu.desc descriptions/genesys.desc \
  descriptions/gphoto2.desc descriptions/gt68xx.desc descriptions/hp3500.desc \
  descriptions/hp3900.desc descriptions/hp4200.desc descriptions/hp5400.desc \
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@ -1,4 +1,4 @@
-# Makefile.in generated by automake 1.13.4 from Makefile.am.
+# Makefile.in generated by automake 1.14.1 from Makefile.am.
 # @configure_input@

 # Copyright (C) 1994-2013 Free Software Foundation, Inc.
@ -336,8 +336,8 @@ man1_MANS = scanimage.1 sane-config.1 sane-find-scanner.1 gamma4scanimage.1
 EXTRA_DIST = scanimage.man sane-config.man sane-find-scanner.man \
 	gamma4scanimage.man sane-abaton.man sane-agfafocus.man \
 	sane-apple.man sane-as6e.man sane-dll.man sane-dc25.man \
-	sane-dmc.man sane-epson.man sane-epson2.man sane-hp.man \
-	sane-gphoto2.man sane-leo.man sane-lexmark.man \
+	sane-dmc.man sane-epson.man sane-epson2.man sane-epsonds.man \
+	sane-hp.man sane-gphoto2.man sane-leo.man sane-lexmark.man \
 	sane-matsushita.man sane-microtek.man sane-microtek2.man \
 	sane-mustek.man sane-nec.man sane-net.man sane-pie.man \
 	sane-pint.man sane-pnm.man sane-umax.man sane-qcam.man \
@ -373,7 +373,7 @@ EXTRA_DIST = scanimage.man sane-config.man sane-find-scanner.man \
 	icons/references.gif icons/references_gr.gif icons/up.gif \
 	icons/up_gr.gif
 BACKEND_5MANS = sane-abaton.5 sane-agfafocus.5 sane-apple.5 sane-as6e.5 \
-	sane-dll.5 sane-dc25.5 sane-dmc.5 sane-epson.5 sane-epson2.5 \
+	sane-dll.5 sane-dc25.5 sane-dmc.5 sane-epson.5 sane-epson2.5 sane-epsonds.5 \
 	sane-hp.5 sane-gphoto2.5 sane-leo.5 sane-lexmark.5 \
 	sane-matsushita.5 sane-microtek.5 sane-microtek2.5 sane-mustek.5 \
 	sane-nec.5 sane-net.5 sane-pie.5 sane-pint.5 sane-pnm.5 \
@ -452,6 +452,7 @@ DESC_FILES = descriptions/abaton.desc descriptions/agfafocus.desc \
  descriptions/dc210.desc descriptions/dc240.desc descriptions/dc25.desc \
  descriptions/dell1600n_net.desc descriptions/dll.desc descriptions/dmc.desc \
  descriptions/epjitsu.desc descriptions/epson2.desc descriptions/epson.desc \
+  descriptions/epsonds.desc \
  descriptions/fujitsu.desc descriptions/genesys.desc \
  descriptions/gphoto2.desc descriptions/gt68xx.desc descriptions/hp3500.desc \
  descriptions/hp3900.desc descriptions/hp4200.desc descriptions/hp5400.desc \
--- a/doc/descriptions/epsonds.desc
+++ b/doc/descriptions/epsonds.desc
@ -0,0 +1,97 @@
+;
+; SANE Backend specification file for the epsonds backend
+;
+; Copyright (C) 2015 Alessandro Zummo
+; Released under GPLv2
+;
+
+:backend "epsonds"
+:version "1.0.18"
+:new :yes
+:manpage "sane-epsonds"
+
+:devicetype :scanner
+
+:mfg "Epson"
+:url "http://www.epson.com/"
+
+:model      "DS-5500"
+:interface  "USB"
+:usbid      "0x04b8" "0x0145"
+:status     :untested
+
+:model      "DS-6500"
+:interface  "USB"
+:usbid      "0x04b8" "0x0145"
+:status     :untested
+
+:model      "DS-7500"
+:interface  "USB"
+:usbid      "0x04b8" "0x0145"
+:status     :untested
+
+:model      "DS-50000"
+:interface  "USB"
+:usbid      "0x04b8" "0x0146"
+:status     :untested
+
+:model      "DS-60000"
+:interface  "USB"
+:usbid      "0x04b8" "0x0146"
+:status     :good
+
+:model      "DS-70000"
+:interface  "USB"
+:usbid      "0x04b8" "0x0146"
+:status     :untested
+
+:model      "DS-510"
+:interface  "USB"
+:usbid      "0x04b8" "0x014c"
+:status     :good
+
+:model      "DS-560"
+:interface  "USB"
+:usbid      "0x04b8" "0x014d"
+:status     :untested
+
+:model      "DS-40"
+:interface  "USB"
+:usbid      "0x04b8" "0x0150"
+:status     :untested
+
+:model      "DS-760"
+:interface  "USB"
+:usbid      "0x04b8" "0x0152"
+:status     :untested
+
+:model      "DS-860"
+:interface  "USB"
+:usbid      "0x04b8" "0x0152"
+:status     :untested
+
+:model      "DS-520"
+:interface  "USB"
+:usbid      "0x04b8" "0x0154"
+:status     :untested
+
+:model      "PX-M7050 Series"
+:interface  "USB"
+:usbid      "0x04b8" "0x08bc"
+:status     :untested
+
+:model      "WF-8510/8590 Series"
+:interface  "USB"
+:usbid      "0x04b8" "0x08bc"
+:status     :untested
+
+:model      "PX-M7050FX Series"
+:interface  "USB"
+:usbid      "0x04b8" "0x08cc"
+:status     :untested
+
+:model      "WF-R8590 Series"
+:interface  "USB"
+:usbid      "0x04b8" "0x08cc"
+:status     :untested
+
--- a/doc/sane-epsonds.man
+++ b/doc/sane-epsonds.man
@ -0,0 +1,101 @@
+.TH sane\-epsonds 5 "29 Mar 2015" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
+.IX sane\-epsonds
+.SH NAME
+sane\-epsonds \- SANE backend for EPSON ESC/I-2 scanners
+.SH DESCRIPTION
+The
+.B sane\-epsonds
+library implements a SANE (Scanner Access Now Easy) backend that
+provides access to Epson ESC/I-2 scanners.
+.PP
+Valid command line options and their syntax can be listed by using 
+.RS
+scanimage \-\-help \-d epsonds
+.RE
+Not all devices support all options.
+.TP
+.I Scan Mode
+The 
+.I \-\-mode 
+switch selects the basic mode of operation of the scanner. Valid choices
+are Lineart, Gray and Color. The Lineart mode is black and white only,
+Gray will produce 256 levels of gray or more depending on the scanner
+and Color means 24 bit color mode or more depending on the scanner.
+Some scanners will internally use 36 bit color, their external interface
+however may only support 24 bits.
+
+The
+.I \-\-depth
+option selects the bit depth the scanner is using. This option is only
+available for scanners that support more than one bit depth. Older
+scanners will always transfer the image in 8bit mode. Newer scanners
+allow to select either 8 bits, 12 or 14 bits per color channel. For a
+color scan this means an effective color depth of 36 or 42 bits over
+all three channels. The valid choices depend on the scanner model.
+
+The 
+.I \-\-resolution
+switch selects the resolution for a scan. Some EPSON scanners will scan in
+any resolution between the lowest and highest possible value. The list
+reported by the scanner can be displayed using the "\-\-help \-d epson"
+parameters to scanimage.
+
+The geometry options
+.I \-l \-t \-x \-y 
+control the scan area: \-l sets the top left x coordinate, \-t the top
+left y coordinate, \-x selects the width and \-y the height of the scan
+area. All parameters are specified in millimeters.
+
+The
+.I \-\-source
+option selects the scan source. Valid options depend on the installed
+options. The default is "Flatbed".
+
+The
+.I \-\-eject
+option ejects the sheet in the ADF.
+
+The
+.I \-\-adf-mode
+option select the ADF mode (simplex/duplex).
+
+.SH CONFIGURATION FILE
+The configuration file @CONFIGDIR@/epsonds.conf specifies the device(s) that the 
+backend will use. Possible connection types are:
+.TP
+.I USB
+For not automatically detected USB scanners, their VENDOR and PRODUCT ID can
+be specified manually in the config file.  
+More information about valid syntax for USB devices can be found in sane\-usb(5).
+.TP
+.I Network (not yet supported)
+Network scanners can be auto-discovered if
+.I autodiscovery
+is specified after 
+.I
+net 
+keyword.  An IP address to connect to can also be used.
+.SH FILES
+.TP
+.I @LIBDIR@/libsane\-epsonds.a
+The static library implementing this backend.
+.TP
+.I @LIBDIR@/libsane\-epsonds.so
+The shared library implementing this backend (present on systems that
+support dynamic loading).
+.SH ENVIRONMENT
+.TP
+.B SANE_DEBUG_EPSONDS
+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. Values around 11-16 will usuallybe enough for
+a bug report.
+
+.SH "SEE ALSO"
+
+sane\-usb(5), scanimage(1), xscanimage(1), xsane(1)
+
+.SH AUTHOR
+
+The package is written by Alessandro Zummo