diff options
Diffstat (limited to 'doc')
50 files changed, 878 insertions, 574 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 7dbbfaf..27c3b59 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -38,7 +38,7 @@ BACKEND_5MANS = sane-abaton.5 sane-agfafocus.5 sane-apple.5 sane-as6e.5 \ sane-hp5590.5 sane-hpljm1005.5 sane-cardscan.5 sane-hp3900.5 \ sane-epjitsu.5 sane-hs2p.5 sane-canon_dr.5 sane-xerox_mfp.5 \ sane-rts8891.5 sane-coolscan3.5 sane-kvs1025.5 sane-kvs20xx.5 \ - sane-kvs40xx.5 sane-p5.5 sane-magicolor.5 + sane-kvs40xx.5 sane-p5.5 sane-magicolor.5 sane-lexmark_x2600.5 EXTRA_DIST += sane-abaton.man sane-agfafocus.man sane-apple.man sane-as6e.man \ sane-canon_lide70.man \ @@ -64,7 +64,7 @@ EXTRA_DIST += sane-abaton.man sane-agfafocus.man sane-apple.man sane-as6e.man \ sane-cardscan.man sane-hp3900.man sane-epjitsu.man sane-hs2p.man \ sane-canon_dr.man sane-xerox_mfp.man sane-rts8891.man \ sane-coolscan3.man sane-kvs1025.man sane-kvs20xx.man sane-kvs40xx.man \ - sane-p5.man sane-magicolor.man + sane-p5.man sane-magicolor.man sane-lexmark_x2600.man man7_MANS = sane.7 EXTRA_DIST += sane.man @@ -130,6 +130,7 @@ BEDOCS += plustek/FAQ \ plustek/Plustek-PARPORT.changes plustek/Plustek-PARPORT.txt \ plustek/Plustek-USB-TODO.txt plustek/Plustek-USB.changes \ plustek/Plustek-USB.txt +BEDOCS += saned/saned.install.md BEDOCS += sceptre/s1200.txt BEDOCS += teco/teco1.txt teco/teco2.txt teco/teco3.txt BEDOCS += u12/U12.changes u12/U12.todo diff --git a/doc/descriptions-external/scangearmp2.desc b/doc/descriptions-external/scangearmp2.desc index d9e3b7e..c09de68 100644 --- a/doc/descriptions-external/scangearmp2.desc +++ b/doc/descriptions-external/scangearmp2.desc @@ -28,6 +28,74 @@ ; Canon MFP2 conf file ; +; ---- V460 -------------------------- +:model "G3070 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18f4" +:status :untested +:comment "Testers needed!" + +:model "G2070 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18f5" +:status :untested +:comment "Testers needed!" + +:model "G4070 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18f3" +:status :untested +:comment "Testers needed!" + +:model "G3030 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1105" +:status :untested +:comment "Testers needed!" + +:model "G2030 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1106" +:status :untested +:comment "Testers needed!" + +:model "TC-20M" +:interface "USB WiFi" +:usbid "0x04a9" "0x18fc" +:status :untested +:comment "Testers needed!" + +:model "TC-5200M" +:interface "USB WiFi" +:usbid "0x04a9" "0x18ff" +:status :untested +:comment "Testers needed!" + +; ---- V450 -------------------------- +:model "TS8630 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18f8" +:status :untested +:comment "Testers needed!" + +:model "XK110 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18f9" +:status :untested +:comment "Testers needed!" + +:model "GX3000 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18f1" +:status :untested +:comment "Testers needed!" + +:model "GX4000 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18f2" +:status :untested +:comment "Testers needed!" + ; ---- V440 -------------------------- :model "TS2400 series" diff --git a/doc/descriptions/canon_lide70.desc b/doc/descriptions/canon_lide70.desc index 3c1dc64..32157dc 100644 --- a/doc/descriptions/canon_lide70.desc +++ b/doc/descriptions/canon_lide70.desc @@ -10,7 +10,7 @@ ; :backend "canon_lide70" ; name of backend -:new :yes +:new :no :url "http://www.juergen-ernst.de/info_sane.html" :version "0" ; version of backend :manpage "sane-canon_lide70" ; name of manpage (if it exists) diff --git a/doc/descriptions/epson2.desc b/doc/descriptions/epson2.desc index ad1d183..b5fc8e2 100644 --- a/doc/descriptions/epson2.desc +++ b/doc/descriptions/epson2.desc @@ -1055,6 +1055,11 @@ :status :complete :comment "network interface supported via DFSG non-free iscan-network-nt package<br>all-in-one" +:model "L360 Series" +:interface "USB" +:usbid "0x04b8" "0x08d1" +:status :complete + :model "L365 Series" :interface "USB" :usbid "0x04b8" "0x08d2" @@ -1724,7 +1729,7 @@ :model "Perfection 610" ; command spec :interface "USB" :usbid "0x04b8" "0x0103" -:status :basic +:status :complete :comment "overseas version of the GT-6600U" :model "Perfection 636S" diff --git a/doc/descriptions/epsonds.desc b/doc/descriptions/epsonds.desc index 989caf8..7e31a18 100644 --- a/doc/descriptions/epsonds.desc +++ b/doc/descriptions/epsonds.desc @@ -358,3 +358,18 @@ :interface "USB" :usbid "0x04b8" "0x11b1" :status :complete + +:model "ES-C220" +:interface "USB" +:usbid "0x04b8" "0x0193" +:status :complete + +:model "DS-C330" +:interface "USB" +:usbid "0x04b8" "0x018f" +:status :complete + +:model "DS-C490" +:interface "USB" +:usbid "0x04b8" "0x0191" +:status :complete diff --git a/doc/descriptions/fujitsu.desc b/doc/descriptions/fujitsu.desc index 6cf8381..aa4b69c 100644 --- a/doc/descriptions/fujitsu.desc +++ b/doc/descriptions/fujitsu.desc @@ -11,13 +11,14 @@ :backend "fujitsu" ; name of backend -:version "139" ; version of backend +:version "140" ; version of backend :manpage "sane-fujitsu" ; name of manpage (if it exists) -:comment "Backend updated for SANE release 1.1.2, see sane-fujitsu manpage" +:comment "This backend supports most Fujitsu and Ricoh fi-series and similar scanners. See manpage for details." :devicetype :scanner ; start of a list of devices.... ; other types: :stillcam, :vidcam, ; :meta, :api +;================================================== :mfg "Fujitsu" ; name a manufacturer :url "http://www.fujitsu.com/" :url "https://fujitsuscanners.com/" @@ -676,3 +677,150 @@ :interface "USB" :status :good :usbid "0x04c5" "0x162e" + + +;================================================== +:mfg "Ricoh" ; name a manufacturer +:url "http://www.ricoh.com/" + +:model "fi-70F" +:interface "USB" +:status :untested +:usbid "0x05ca" "0x0308" + +:model "fi-400F" +:interface "USB" +:status :untested +:usbid "0x04c5" "0x151e" + +:model "fi-800R" +:interface "USB" +:status :good +:usbid "0x04c5" "0x15fc" +:comment "Both feed methods are supported." + +:model "fi-7300NX" +:interface "USB" +:status :good +:usbid "0x04c5" "0x1575" +:comment "Ethernet and WiFi not supported." + +:model "fi-7460" +:interface "USB" +:status :good +:usbid "0x04c5" "0x14be" + +:model "fi-7480" +:interface "USB" +:status :good +:usbid "0x04c5" "0x14b8" + +:model "fi-7600" +:interface "USB" +:status :good +:usbid "0x04c5" "0x1521" + +:model "fi-7700" +:interface "USB" +:status :good +:usbid "0x04c5" "0x1520" + +:model "fi-7700S" +:interface "USB" +:status :untested +:usbid "0x04c5" "0x1522" + +:model "fi-7800" +:interface "USB" +:status :good +:usbid "0x04c5" "0x160b" + +:model "fi-7900" +:interface "USB" +:status :good +:usbid "0x04c5" "0x160a" + +:model "fi-8040" +:interface "USB" +:status :untested +:usbid "0x05ca" "0x0307" + +:model "fi-8150" +:interface "USB" +:status :good +:usbid "0x04c5" "0x1601" +:comment "Ethernet not supported." + +:model "fi-8150U" +:interface "USB" +:status :good +:usbid "0x04c5" "0x162d" + +:model "fi-8170" +:interface "USB" +:status :good +:usbid "0x04c5" "0x15ff" +:comment "Ethernet not supported." + +:model "fi-8190" +:interface "USB" +:status :good +:usbid "0x04c5" "0x15fd" +:comment "Ethernet not supported." + +:model "fi-8250" +:interface "USB" +:status :good +:usbid "0x04c5" "0x1602" +:comment "Ethernet not supported." + +:model "fi-8250U" +:interface "USB" +:status :good +:usbid "0x04c5" "0x162e" + +:model "fi-8270" +:interface "USB" +:status :good +:usbid "0x04c5" "0x1600" +:comment "Ethernet not supported." + +:model "fi-8290" +:interface "USB" +:status :good +:usbid "0x04c5" "0x15fe" +:comment "Ethernet not supported." + +:model "N7100" +:interface "USB Ethernet" +:status :untested +:usbid "0x04c5" "0x146f" + +:model "ScanSnap iX100" +:interface "USB WiFi" +:status :good +:usbid "0x04c5" "0x13f4" +:comment "WiFi not supported." + +:model "ScanSnap iX1300" +:interface "USB WiFi" +:status :good +:usbid "0x04c5" "0x162c" +:comment "WiFi not supported." + +:model "ScanSnap iX1400" +:interface "USB" +:status :untested +:usbid "0x04c5" "0x1630" + +:model "ScanSnap iX1600" +:interface "USB WiFi" +:status :good +:usbid "0x04c5" "0x1632" +:comment "WiFi not supported." + +:model "ScanSnap SV600" +:interface "USB" +:status :unsupported +:usbid "0x04c5" "0x128e" +:comment "Also has a second USB VID 0x13ba. Will require some gymnastics to support." diff --git a/doc/descriptions/genesys.desc b/doc/descriptions/genesys.desc index 33fe735..740c246 100644 --- a/doc/descriptions/genesys.desc +++ b/doc/descriptions/genesys.desc @@ -253,7 +253,7 @@ :status :complete :comment "300, 600, 1200 dpi resolutions supported in flatbed scanning mode; 300, 600, 1200, 2400, 4800 dpi resolutions are supported in transparency and infrared transparency scanning modes" -:model "CanoScan 700F" +:model "CanoScan LiDE 700F" :interface "USB" :usbid "0x04a9" "0x1907" :status :basic diff --git a/doc/descriptions/lexmark_x2600.desc b/doc/descriptions/lexmark_x2600.desc new file mode 100644 index 0000000..0ff4efd --- /dev/null +++ b/doc/descriptions/lexmark_x2600.desc @@ -0,0 +1,32 @@ +; +; 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 "lexmark_x2600" ; name of backend +:version "1.0-0" ; version of backend (or "unmaintained") +:manpage "sane-lexmark_x2600" ; name of manpage (if it exists) +:url "https://gitlab.com/sane-project/backends/" + ; backend's web page +:new :yes +:comment "This backend supports lexmark x2600 series scanners." + ; comment about the backend + +:devicetype :scanner ; start of a list of devices.... + ; other types: :stillcam, :vidcam, + ; :meta, :api + +:mfg "Lexmark" ; name a manufacturer +:url "http://www.lexmark.com/" ; manufacturer's URL + +:model "X2670" +:interface "USB" +:usbid "0x043d" "0x011d" +:status :good +:comment "Supports 75, 150, 300, 600 dpi" diff --git a/doc/descriptions/pixma.desc b/doc/descriptions/pixma.desc index b1a5657..07c4740 100644 --- a/doc/descriptions/pixma.desc +++ b/doc/descriptions/pixma.desc @@ -136,12 +136,24 @@ :status :untested :comment "Testers needed!" +:model "G2030 series" +:interface "USB" +:usbid "0x04a9" "0x1106" +:status :untested +:comment "Testers needed!" + :model "PIXMA G2060" :interface "USB" :usbid "0x04a9" "0x18c1" :status :untested :comment "Testers needed!" +:model "G2070 series" +:interface "USB" +:usbid "0x04a9" "0x18f5" +:status :untested +:comment "Testers needed!" + :model "PIXMA G2100" :interface "USB" :usbid "0x04a9" "0x1795" @@ -166,12 +178,24 @@ :status :untested :comment "Testers needed!" +:model "G3030 series" +:interface "USB" +:usbid "0x04a9" "0x1105" +:status :untested +:comment "Testers needed!" + :model "PIXMA G3060" :interface "USB" :usbid "0x04a9" "0x18c3" :status :untested :comment "Testers needed!" +:model "G3070 series" +:interface "USB" +:usbid "0x04a9" "0x18f4" +:status :untested +:comment "Testers needed!" + :model "PIXMA G4000 Series" :interface "USB WiFi" :usbid "0x04a9" "0x181d" @@ -184,6 +208,12 @@ :status :untested :comment "Testers needed!" +:model "G4070 series" +:interface "USB" +:usbid "0x04a9" "0x18f3" +:status :untested +:comment "Testers needed!" + :model "PIXMA G4511" :interface "USB WiFi" :usbid "0x04a9" "0x183d" @@ -226,12 +256,42 @@ :status :untested :comment "Testers needed!" +:model "PIXMA GX1000 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x110b" +:status :untested +:comment "Testers needed!" + +:model "PIXMA GX2000 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x110d" +:status :untested +:comment "Testers needed!" + +:model "PIXMA GX3000 Series" +:interface "USB" +:usbid "0x04a9" "0x18f1" +:status :untested +:comment "Testers needed!" + +:model "PIXMA GX4000" +:interface "USB" +:usbid "0x04a9" "0x18f2" +:status :untested +:comment "Testers needed!" + :model "PIXMA GX6000 Series" -:interface "USB Ethernet WiFi" +:interface "USB" :usbid "0x04a9" "0x18a6" :status :untested :comment "Testers needed!" +:model "PIXMA GX6500 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1148" +:status :untested +:comment "Testers needed!" + :model "PIXMA GX7000" :interface "USB" :usbid "0x04a9" "0x18a8" @@ -935,6 +995,18 @@ :status :complete :comment "Flatbed and ADF scan. All resolutions supported (up to 4800DPI)" +:model "TC-20M" +:interface "USB" +:usbid "0x04a9" "0x18fc" +:status :untested +:comment "Testers needed!" + +:model "TC-5200M" +:interface "USB" +:usbid "0x04a9" "0x18ff" +:status :untested +:comment "Testers needed!" + :model "PIXMA TR4500 Series" :interface "USB WiFi" :usbid "0x04a9" "0x1854" @@ -977,6 +1049,12 @@ :status :untested :comment "Testers needed!" +:model "PIXMA TR7800 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1151" +:status :untested +:comment "Testers needed!" + :model "PIXMA TR8500 Series" :interface "USB Ethernet WiFi" :usbid "0x04a9" "0x1823" @@ -1163,6 +1241,18 @@ :status :good :comment "All resolutions supported (up to 1200DPI). WiFi not tested by Pixma as yet." +:model "PIXMA TS6630 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x114e" +:status :untested +:comment "Testers needed!" + +:model "PIXMA TS6730 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1150" +:status :untested +:comment "Testers needed!" + :model "PIXMA TS7330 Series" :interface "USB WiFi" :usbid "0x04a9" "0x188f" @@ -1193,6 +1283,30 @@ :status :untested :comment "Testers needed!" +:model "PIXMA TS7600i series" +:interface "USB WiFi" +:usbid "0x04a9" "0x114f" +:status :untested +:comment "Testers needed!" + +:model "PIXMA TS7700 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x110f" +:status :untested +:comment "Testers needed!" + +:model "PIXMA TS7700A series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1111" +:status :untested +:comment "Testers needed!" + +:model "PIXMA TS7700i series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1152" +:status :untested +:comment "Testers needed!" + :model "PIXMA TS8000 Series" :interface "USB WiFi" :usbid "0x04a9" "0x1800" @@ -1265,6 +1379,18 @@ :status :untested :comment "Testers needed!" +:model "PIXMA TS8630 Series" +:interface "USB" +:usbid "0x04a9" "0x18f8" +:status :untested +:comment "Testers needed!" + +:model "PIXMA TS8700 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1118" +:status :untested +:comment "Testers needed!" + :model "PIXMA TS9000 Series" :interface "USB WiFi" :usbid "0x04a9" "0x179f" @@ -1337,6 +1463,18 @@ :status :untested :comment "Testers needed!" +:model "PIXUS XK110 Series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18f9" +:status :untested +:comment "Testers needed!" + +:model "PIXUS XK120 Series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1119" +:status :untested +:comment "Testers needed!" + :model "PIXUS XK500 Series" :interface "USB WiFi" :usbid "0x04a9" "0x18df" @@ -1505,6 +1643,12 @@ :status :complete :comment "Flatbed and ADF scan. All resolutions supported (up to 600DPI)." +:model "i-SENSYS MF750 Series" +:interface "USB Ethernet WiFi" +:usbid "0x04a9" "0x2885" +:status :untested +:comment "Testers needed!" + :model "i-SENSYS MF810/820" :interface "USB Ethernet" :usbid "0x04a9" "0x27a6" diff --git a/doc/descriptions/ricoh.desc b/doc/descriptions/ricoh.desc index bdaea31..56b027e 100644 --- a/doc/descriptions/ricoh.desc +++ b/doc/descriptions/ricoh.desc @@ -17,12 +17,12 @@ :mfg "Ricoh" ; name a manufacturer :url "http://www.ricoh.com/" -:model "Ricoh IS50" ; name models for above-specified mfg. +:model "IS50" ; name models for above-specified mfg. :interface "SCSI" :status :basic ;:comment "?" -:model "Ricoh IS60" ; name models for above-specified mfg. +:model "IS60" ; name models for above-specified mfg. :interface "SCSI" :status :basic ;:comment "?" diff --git a/doc/descriptions/template.desc b/doc/descriptions/template.desc index a6b6bab..d7b8eb3 100644 --- a/doc/descriptions/template.desc +++ b/doc/descriptions/template.desc @@ -12,7 +12,7 @@ :backend "template" ; name of backend :version "0.42" ; version of backend (or "unmaintained") -:new :yes ; Is the backend new to this SANE release? +:new :no ; Is the backend new to this SANE release? ; :yes or :no :manpage "sane-template" ; name of manpage (if it exists) :url "http://www.luser.com/temp/" ; backend's web page diff --git a/doc/descriptions/xerox_mfp.desc b/doc/descriptions/xerox_mfp.desc index f78bf94..ad6355d 100644 --- a/doc/descriptions/xerox_mfp.desc +++ b/doc/descriptions/xerox_mfp.desc @@ -43,6 +43,12 @@ :usbid "0x0924" "0x42dc" :status :good +:model "WorkCentre 3335" +:interface "USB" +:usbid "0x0924" "0x42e2" +:status :basic +:comment "When scanning from automatic feeder, only the first page is scanned" + :mfg "Dell" :url "http://www.dell.com/" @@ -56,6 +62,11 @@ :usbid "0x413c" "0x5310" :status :good +:model "Dell 1135n" +:interface "USB Ethernet" +:usbid "0x413c" "0x5318" +:status :good + :mfg "Samsung" :url "http://www.samsung.com" diff --git a/doc/sane-apple.man b/doc/sane-apple.man index ef7d4ce..dc835cb 100644 --- a/doc/sane-apple.man +++ b/doc/sane-apple.man @@ -84,7 +84,7 @@ support dynamic loading). .SH ENVIRONMENT .TP .B SANE_CONFIG_DIR -This environment variable is list of directories where SANE looks +This environment variable is a list of directories where SANE looks for the configuration file. On *NIX systems, directory names are separated by a colon (`:'), under OS/2 by a semi-colon (`;'). If SANE_CONFIG_DIR is not set, SANE defaults to @@ -177,7 +177,6 @@ bugs. We know we have a GUI bug when a parameter is not showing up when it should (active) or vice versa. Finding out which parameters are active across various Apple modes and models from the documentation -.I ftp://ftpdev.info.apple.com/devworld/Technical_Documentation/Peripherals_Documentation/ is an interesting exercise. I may have missed some dependencies. For example of the threshold parameter the Apple Scanners Programming Guide says nothing. I had to assume it is valid only in LineArt mode. @@ -238,7 +237,8 @@ looks like, goto to .I apple.h and #define the .B NEUTRALIZE_BACKEND -macro. You can select the scanner model through the APPLE_MODEL_SELECT +macro. You can select the scanner model through the +.B APPLE_MODEL_SELECT macro. Available options are .BR APPLESCANNER , .BR ONESCANNER , @@ -246,7 +246,9 @@ and .BR COLORONESCANNER . .PP If you encounter a SCSI bus error or trimmed and/or displaced images please -set the environment variable SANE_DEBUG_SANEI_SCSI to 255 before sending me +set the environment variable +.B SANE_DEBUG_SANEI_SCSI +to 255 before sending me the report. .SH TODO @@ -257,12 +259,12 @@ Make a non blocking backend. Properly support .BR sane_set_io_mode () and -.BR sane_get_select_fd () +.BR sane_get_select_fd (). .TP .B Scan Make scanning possible for all models in all supported modes. .PP -Add other missing functionality +Add other missing functionality. .SH "SEE ALSO" .BR sane (7), @@ -274,4 +276,4 @@ The backend was written not entirely from scratch by Milon Firikis. It is mostly based on the .BR sane\-mustek (5) -backend from David Mosberger and Andreas Czechanowski +backend from David Mosberger and Andreas Czechanowski. diff --git a/doc/sane-artec_eplus48u.man b/doc/sane-artec_eplus48u.man index fa6fe7f..bf1ce79 100644 --- a/doc/sane-artec_eplus48u.man +++ b/doc/sane-artec_eplus48u.man @@ -50,7 +50,9 @@ find the firmware file under .SH CONFIGURATION The contents of the .I artec_eplus48u.conf -file is a list of usb lines containing vendor and product ids that correspond +file is a list of +.I usb +lines containing vendor and product ids that correspond to USB scanners. The file can also contain option lines. Empty lines and lines starting with a hash mark (#) are ignored. The scanners are autodetected by @@ -59,7 +61,9 @@ statements which are already included into .I artec_eplus48u.conf . "vendor_id" and "product_id" are hexadecimal numbers that identify the scanner. .PP -Every usb section can have additional options. +Every +.I usb +section can have additional options. .TP .B artecFirmwareFile @DATADIR@/sane/artec_eplus48u/Artec48.usb The path to the firmware file. This option is required. diff --git a/doc/sane-bh.man b/doc/sane-bh.man index 218fd39..baa49a5 100644 --- a/doc/sane-bh.man +++ b/doc/sane-bh.man @@ -89,7 +89,7 @@ compression is disabled and the image is delivered in a frame. .TP .B \-\-mode lineart|halftone [lineart] -Selects the scan mode (e.g., lineart,monochrome, or color). +Selects the scan mode (e.g., lineart, monochrome, or color). .TP .B \-\-resolution 200|240|300dpi [200] Sets the resolution of the scanned image. Each scanner model supports @@ -148,7 +148,8 @@ Bottom-right y position of scan area. .B \-\-source Automatic Document Feeder|Manual Feed Tray [Automatic Document Feeder] Selects the scan source (such as a document feeder). This option is provided to allow multiple image scans with -.BR xsane (1); it has no other purpose. +.BR xsane (1); +it has no other purpose. .TP .B \-\-batch[=(yes|no)] [no] Enable/disable batch mode scanning. Batch mode allows scanning at maximum throughput @@ -171,7 +172,7 @@ Sets the timeout in seconds for semi-automatic feeder. The value 0 specifies the hardware default value which varies based on the scanner model. .TP .B \-\-check\-adf[=(yes|no)] [no] -Check ADF Status prior to starting scan using the OBJECT POSITION command. +Check ADF status prior to starting scan using the OBJECT POSITION command. Note that this feature requires RSC firmware level 1.5 or higher and dip switch 4 must be in the on position. NOTE: This option has not been tested extensively and may produce undesirable results. @@ -381,7 +382,7 @@ with a hash mark (#) are ignored. .SH OPTIONS The following options can be specified in the .I bh.conf -file. +file: .TP .B disable\-optional\-frames This option prevents the backend from sending any optional frames. This @@ -544,7 +545,9 @@ prior to initiating the last scan command. Currently, there is no mechanism available for the frontend to pass this knowledge to the backend. If batch mode is enabled and the .B \-\-end\-count -terminates a scanadf session, +terminates a +.BR scanadf (1) +session, an extra page will be pulled through the scanner, but is neither read nor delivered to the frontend. The issue can be avoided by specifying .B \-\-batch=no @@ -556,7 +559,7 @@ with revision 1.2 or higher that is faster and more reliable than the standard Bar/Patch code decoder. This is not currently supported. .SH BUGS -This is a new backend; detailed bug reports are welcome -- and expected ;) +Detailed bug reports are welcome -- and expected ;) .PP If you have found something that you think is a bug, please attempt to recreate it with the diff --git a/doc/sane-canon_pp.man b/doc/sane-canon_pp.man index 6889c05..01c651d 100644 --- a/doc/sane-canon_pp.man +++ b/doc/sane-canon_pp.man @@ -68,30 +68,28 @@ The supported options are currently and .BR force_nibble -Option -.B ieee1284 -.IR port-name -defines which port to use. The format of port-name is OS dependent, based on -the names presented by libieee1284. Please only have one of these lines, or +.TP +.B ieee1284 port-name +Defines which port to use. The format of port-name is OS dependent, based on +the names presented by +.BR libieee1284 (3). +Please only have one of these lines, or all but one will be ignored. -Option -.B calibrate -.IR cal-file -.IR [port-name] -defines which calibration file to use on a per-port basis. If you only have +.TP +.B calibrate cal-file [port-name] +Defines which calibration file to use on a per-port basis. If you only have one parport, the port-name argument may be omitted \- but be careful as this will cause problems on multi-scanner systems. You may have as many of these lines as you like, as long as each has a unique port name. The tilde (`~') -character is acceptable and will be expanded to the value of the HOME -environment. +character is acceptable and will be expanded to the value of the +.B HOME +environment variable. -Option -.B init_mode -.IR <AUTO|FB620P|FB630P> -.IR [portname] -defines which initialisation (wake-up) mode to use on a per-port basis. -If you only have one parport, the portname argument may be omitted \- but +.TP +.B init_mode <AUTO|FB620P|FB630P> [port-name] +Defines which initialisation (wake-up) mode to use on a per-port basis. +If you only have one parport, the port-name argument may be omitted \- but be careful as this may cause problems on multi-scanner systems. You may have as many of these lines as you like, as long as each has a unique port name. The valid initialisation modes are FB620P (which strobes 10101010 @@ -100,10 +98,11 @@ on the data pins) and AUTO, which will try FB630P mode first then FB620P mode second. The FB620P mode is also used by the FB320P. The FB630P mode is used by the FB330P, N340P, and N640P. -Option +.TP .B force_nibble -forces the driver to use nibble mode even if ECP mode is reported to work by -libieee1284. This works-around the rare issue of ECP mode being reported to +Forces the driver to use nibble mode even if ECP mode is reported to work by +.BR libieee1284 (3). +This works-around the rare issue of ECP mode being reported to work by the library, then not working. .SH TIPS @@ -174,7 +173,9 @@ one returned during calibration) will be loaded. .PP .B Communication Problems .PP -ECP mode in libieee1284 doesn't always work properly, even with new hardware. +ECP mode in +.BR libieee1284 (3) +doesn't always work properly, even with new hardware. We believe that this is a ppdev problem. If you change the configuration file to include .B force_nibble diff --git a/doc/sane-coolscan2.man b/doc/sane-coolscan2.man index 84e8a93..9d6d4aa 100644 --- a/doc/sane-coolscan2.man +++ b/doc/sane-coolscan2.man @@ -123,9 +123,9 @@ Eject the film strip or mounted slide when using the slide loader. .TP .B \-\-reset Reset scanner. The scanner will perform the same action as when power is -turned on: it will eject the film strip (with the SF\-200 bulk feeder) +turned on: it will eject the slide (with the SF\-200 bulk feeder) and calibrate itself. Use this whenever the scanner refuses to load -a film strip properly, as a result of +a slide properly, as a result of which .B \-\-eject does not work. diff --git a/doc/sane-coolscan3.man b/doc/sane-coolscan3.man index 7c59f43..f04f2ce 100644 --- a/doc/sane-coolscan3.man +++ b/doc/sane-coolscan3.man @@ -82,7 +82,9 @@ unit is mm). If set to "yes", the scanner will read the infrared channel, thus allowing defect removal in software. The infrared image is read during a second scan, with no options altered. The backend must not be restarted between the scans. -If you use scanimage, perform a batch scan with +If you use +.BR scanimage (1), +perform a batch scan with .B \-\-batch\-count=2 to obtain the IR information. .TP @@ -120,9 +122,9 @@ Eject the film strip or mounted slide when using the slide loader. .TP .B \-\-reset Reset scanner. The scanner will perform the same action as when power is -turned on: it will eject the film strip (with the SF\-200 bulk loader) +turned on: it will eject the slide (with the SF\-200 bulk loader) and calibrate itself. Use this -whenever the scanner refuses to load a film strip properly, as a result of +whenever the scanner refuses to load a slide properly, as a result of which .B \-\-eject does not work. diff --git a/doc/sane-dmc.man b/doc/sane-dmc.man index eee5e92..a406462 100644 --- a/doc/sane-dmc.man +++ b/doc/sane-dmc.man @@ -49,7 +49,9 @@ This image is a 1599-by-1200 pixel full-color image constructed by filtering and interpolating the "raw" image. The filtering and interpolation is done in software, so this mode is very slow. Also, this mode places restrictions on how the image is read which means that the "preview" mode -of xscanimage does not work in Super Resolution mode. +of +.BR xscanimage (1) +does not work in Super Resolution mode. .RB ( xcam (1) and the non-preview modes of .BR scanimage (1) @@ -146,8 +148,8 @@ like. .BR sane\-scsi (5) .SH AUTHOR -David F. Skoll +Dianne Skoll <dianne@skoll.ca> .PP The backend is derived from .BR sane\-hp (5) -by David Mosberger +by David Mosberger. diff --git a/doc/sane-epjitsu.man b/doc/sane-epjitsu.man index ccf75f6..8eb7287 100644 --- a/doc/sane-epjitsu.man +++ b/doc/sane-epjitsu.man @@ -2,7 +2,7 @@ .IX sane\-epjitsu .SH NAME -sane\-epjitsu \- SANE backend for Epson-based Fujitsu USB scanners. +sane\-epjitsu \- SANE backend for Epson-based Fujitsu USB scanners .SH DESCRIPTION The @@ -35,12 +35,12 @@ Selects the source for the scan. Options may include "Flatbed", "ADF Front", "AD Selects the mode for the scan. Options may include "Lineart", "Gray", "Color". .RE .PP -.B resolution, y\-resolution +.BR resolution , " y\-resolution" .RS Controls scan resolution. Setting .B \-\-resolution also sets -.B \-\-y\-resolution, +.BR \-\-y\-resolution , though this behavior is overridden by some frontends. .RE .PP diff --git a/doc/sane-epson.man b/doc/sane-epson.man index 75ffad3..bfcf32d 100644 --- a/doc/sane-epson.man +++ b/doc/sane-epson.man @@ -5,12 +5,12 @@ sane\-epson \- SANE backend for EPSON scanners .SH DESCRIPTION The .B sane\-epson -library implements a SANE Scanner Access Now Easy) backend that +library implements a SANE (Scanner Access Now Easy) backend that provides access to Epson flatbed scanners. Some functions of this backend should be considered .B beta-quality software! Most functions have been stable for a long time, but of -course new development can not and often times will not function properly from +course new development can not and often will not function properly from the very first day. Please report any strange behavior to the maintainer of the backend. .PP @@ -255,8 +255,9 @@ The parallel interface can be configured in two ways: An integer value starting at the beginning of a line will be interpreted as the IO address of the parallel port. To make it clearer that a configured IO address is a parallel port the port address can be preceded by the string "PIO". The PIO connection does not -use a special device file in the /dev directory. The IO address can be specified -in hex mode (prefixed with "0x"). +use a special device file in the +.I /dev +directory. The IO address can be specified in hex mode (prefixed with "0x"). .TP .I USB A device file that is preceded by the string "USB" is treated as a scanner diff --git a/doc/sane-epson2.man b/doc/sane-epson2.man index 6c6b9a3..0e6d721 100644 --- a/doc/sane-epson2.man +++ b/doc/sane-epson2.man @@ -266,7 +266,7 @@ will ignore this option. The .B \-\-bay -option selects which bay to scan +option selects which bay to scan. The .B \-\-eject diff --git a/doc/sane-fujitsu.man b/doc/sane-fujitsu.man index 0485d2a..b45c325 100644 --- a/doc/sane-fujitsu.man +++ b/doc/sane-fujitsu.man @@ -1,16 +1,16 @@ -.TH sane\-fujitsu 5 "15 Nov 2022" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.TH sane\-fujitsu 5 "24 Mar 2023" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" .IX sane\-fujitsu .SH NAME -sane\-fujitsu \- SANE backend for Fujitsu flatbed and ADF scanners +sane\-fujitsu \- SANE backend for Fujitsu and Ricoh fi series scanners .SH DESCRIPTION The .B sane\-fujitsu library implements a SANE (Scanner Access Now Easy) backend which provides -access to most Fujitsu flatbed and ADF scanners. +access to most Fujitsu flatbed and ADF scanners, and the subsequent Ricoh models. -This document describes backend version 139, which initially shipped with SANE 1.1.2. +This document describes backend version 140. .SH SUPPORTED HARDWARE This version supports every known model which speaks the Fujitsu SCSI and @@ -20,14 +20,14 @@ supported. Please see the list at .I http://www.sane\-project.org/sane\-supported\-devices.html for details. -This backend may support other Fujitsu scanners. The best +This backend may support other Fujitsu or newer Ricoh scanners. The best way to determine level of support is to test the scanner directly, or to collect a trace of the windows driver in action. Please contact the author for help or with test results. .SH UNSUPPORTED HARDWARE The following scanners are known NOT to work with this backend, -either because they have a non\-Fujitsu chipset, or an unsupported +either because they have an unsupported chipset, or an unsupported interface type. Some of these scanners may be supported by another backend. .PP @@ -152,7 +152,7 @@ specify one. Probably should not be used with the other "scsi" line above. .RS Requests backend to search all usb buses in the system for a device which uses that vendor and product id. The device will then be queried -to determine if it is a Fujitsu scanner. +to determine if it is a supported scanner. .RE .PP "usb /dev/usb/scanner0" (or other device file) diff --git a/doc/sane-genesys.man b/doc/sane-genesys.man index 85b80ff..b4767ab 100644 --- a/doc/sane-genesys.man +++ b/doc/sane-genesys.man @@ -48,7 +48,8 @@ GL841, GL843, GL847 or GL124 chipset, you can try to add it to the backend. .SH "CALIBRATION" To give correct image quality, sheet fed scanners need to be calibrated using the calibration sheet sold with the scanner. To do calibration, you must insert this target -in the feeder then start calibration either by passing the \-\-calibrate option to scanimage +in the feeder then start calibration either by passing the \-\-calibrate option to +.BR scanimage (1) or by clicking on the available 'calibrate' button in the 'advanced options' in a graphical frontend. The result of the calibration is stored in a file in the home directory of the user doing it. If you plug the scanner in another machine or use it with another account, calibration @@ -100,7 +101,7 @@ Disable use of a software adaptive algorithm to generate lineart and rely on har .TP .B \-\-color-filter None|Red|Green|Blue When using gray or lineart this option selects the used color. Using a color filter -will give a monochrome scan. CIS based scanners can to true gray when no filter (None value) is +will give a monochrome scan. CIS based scanners can do true gray when no filter (None value) is selected. .TP @@ -123,7 +124,7 @@ users. .B \-\-expiration\-time Specify the time (in minutes) a cached calibration is considered valid. If older than the given value, a new calibration is done. A value of -1 means no expiration and cached value are kept forever unless cleared by -userwith the calibration clear option. A value of 0 means cache is disabled. +user with the calibration clear option. A value of 0 means cache is disabled. .PP Additionally, several 'software' options are exposed by the backend. These @@ -248,9 +249,7 @@ Syscan/Ambir DocketPORT 467/485/487/665/685 Xerox Travel Scanner 100, Onetouch 2400 .RE .TP -cncsolutions -.RI ( http://www.cncsolutions.com.br ) -sponsored and supported the work on the Panasonic KV-SS080. +cncsolutions sponsored and supported the work on the Panasonic KV-SS080. .br .TP Brian Paavo from Benthic Science Limited for donating a Canoscan LiDE 700F. @@ -298,7 +297,8 @@ due to the way image sensors are built. .PP This backend will be much slower if not using libusb\-1.0. So be sure that sane\-backends is built with the -.B \-\-enable-libusb_1_0 option. +.B \-\-enable-libusb_1_0 +option. .SH "BUGS" For the LiDE 200, the scanned data at 4800 dpi is obtained "as is" from sensor. diff --git a/doc/sane-gphoto2.man b/doc/sane-gphoto2.man index 2b2d66f..f7ee918 100644 --- a/doc/sane-gphoto2.man +++ b/doc/sane-gphoto2.man @@ -32,7 +32,7 @@ through the gphoto2 interface. Valid ports and cameras can be obtained by .I "gphoto2 \-\-list\-cameras" and -.I "gphoto2 \-\-list\-ports". +.IR "gphoto2 \-\-list\-ports" . .PP The .B dumpinquiry @@ -122,9 +122,9 @@ Set to 1, 2, or 3, to enable various levels of debugging within the gphoto2 libraries. .SH "SEE ALSO" -.BR sane (7) , -.BR scanimage (1) , -.BR xscanimage (1) , +.BR sane (7), +.BR scanimage (1), +.BR xscanimage (1), .BR libgphoto2 (3) .SH AUTHOR diff --git a/doc/sane-hp.man b/doc/sane-hp.man index d0b0ff8..2fe4649 100644 --- a/doc/sane-hp.man +++ b/doc/sane-hp.man @@ -45,19 +45,18 @@ and .IR http://penguin-breeder.org/kernel/download/ . .PP -Support for models 5200C/62X0C/63X0C connected to the USB require -the kernel scanner driver or libusb. See +Support for models 5200C/62X0C/63X0C connected to USB requires +libusb. See .BR sane\-usb (5) for more details. .PP The .B sane\-hp backend no longer supports OfficeJet multi-function peripherals. -For these devices use the external "hpoj" backend in version 0.90 and later of -the "HP OfficeJet Linux driver", available at -.br -.IR http://hpoj.sourceforge.net -. +For these devices use the external "hplip" packages available at: +.IR https://developers.hp.com/hp\-linux\-imaging\-and\-printing/ . +For information about the previous hpoj driver, see: +.IR http://hpoj.sourceforge.net/ . .PP Because Hewlett-Packard does no longer produce scanners that support SCL (beside the OfficeJets), the above list of supported scanners is @@ -70,7 +69,7 @@ You can also watch the sane\-devel mailing list at .IR http://www.sane\-project.org/mailing\-lists.html . .PP More details about the hp backend can be found on its homepage -.IR http://www.kirchgessner.net/sane.html . +.IR http://web.archive.org/web/20070206115546/http://www.kirchgessner.net/sane.html . .PP .SH "DEVICE NAMES" This backend expects device names of the form: @@ -220,8 +219,9 @@ levels reduce verbosity. .TP .B SANE_HOME_HP Only used for OS/2 and along with use of HP PhotoSmart PhotoScanner. -Must be set to the directory where the directory .sane is located. -Is used to save and read the calibration file. +Must be set to the directory where the directory +.I .sane +is located. Is used to save and read the calibration file. .TP .B SANE_HP_KEEPOPEN_SCSI .TP diff --git a/doc/sane-lexmark_x2600.man b/doc/sane-lexmark_x2600.man new file mode 100644 index 0000000..bc7c386 --- /dev/null +++ b/doc/sane-lexmark_x2600.man @@ -0,0 +1,62 @@ +.TH "sane\-lexmark_x2600" "5" "23 Dec 2023" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.IX sane\-lexmark_x2600 +.SH "NAME" +sane\-lexmark_x2600 \- SANE backend for Lexmark X2600 Series scanners +.SH "DESCRIPTION" +The +.B sane\-lexmark +library implements a SANE (Scanner Access Now Easy) backend that +provides access to the scanner part of Lexmark X2600 AIOs. +.PP +The scanners that should work with this backend are: +.PP +.RS +.ft CR +.nf + Vendor Model status +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\- + Lexmark X2670 good +.fi +.ft R +.RE + +The options the backend supports can either be selected through +command line options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +, +.BR xsane (1). +or +.BR simple-scan (1). +.br +If you notice any strange behavior, please report to the backend +maintainer or to the SANE mailing list. + +.SH "FILES" +.TP +.I @LIBDIR@/libsane\-lexmark_x2600.a +The static library implementing this backend. +.TP +.I @LIBDIR@/libsane\-lexmark_x2600.so +The shared library implementing this backend (present on systems that +support dynamic loading). + +.SH "ENVIRONMENT" +.TP +.B SANE_DEBUG_LEXMARK_X2600 +If the library was compiled with debug support enabled, this +environment variable controls the debug level for this backend. E.g., +a value of 255 requests all debug output to be printed. Smaller levels +reduce verbosity. + +.SH "AUTHOR" +.TP +The backend was originally written by Benoit Juin. +.RI < benoit.juin@gmail.com > + +.SH "CREDITS" +.TP +Many thanks go to: +@skelband aka Ralph Little who help me to dive in the sane-backencode and +reviewed the sources. diff --git a/doc/sane-matsushita.man b/doc/sane-matsushita.man index 2030f2c..d4b0184 100644 --- a/doc/sane-matsushita.man +++ b/doc/sane-matsushita.man @@ -27,14 +27,14 @@ backend: .ft R .RE .PP -(*) WARNING: None of the advanced options of these scanners are available (ie no color, no high resolution, no automatic cropping). Basically, the driver does no more than what it does for the KV-SS25. I don't have access to such scanners, and thus cannot add these options. +(*) WARNING: None of the advanced options of these scanners are available (i.e. no color, no high resolution, no automatic cropping). Basically, the driver does no more than what it does for the KV-SS25. I don't have access to such scanners, and thus cannot add these options. Other Panasonic high speed scanners may or may not work with that backend. -Valid command line options and their syntax can be listed by using +Valid command line options and their syntax can be listed by using: .RS .PP -scanimage \-\-help \-d matsushita +.I scanimage \-\-help \-d matsushita .RE .TP @@ -58,13 +58,13 @@ selects the number of pages to scan (one or until the tray is empty). .TP .B \-\-paper\-size A4|...|Legal|Letter [A4] -options selects the area to scan. It adjust the +selects the area to scan. It adjusts the .B \-l \-t \-x \-y options accordingly. It does not need to be the real size of the paper. .TP .B \-l \-t \-x \-y -control the scan area: \-l sets the top left x coordinate, \-t the top +controls 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. It is possible to use the option @@ -85,28 +85,28 @@ controls the contrast of the acquired image. Some models do not support that opt automatically sets brightness, contrast, white level, gamma, noise reduction and image emphasis. These options are not available when automatic\-threshold is in use. .TP .B \-\-halftone\-pattern -option sets the tonal gradation for the halftone mode. Pattern downloading is not implemented by the backend. +sets the tonal gradation for the halftone mode. Pattern downloading is not implemented by the backend. .TP .B \-\-autoseparation provides automatic separation of text and images. .TP .B \-\-white\-level -option indicate the source of the white base. +indicates the source of the white base. .TP .B \-\-noise\-reduction reduces the isolated dot noise. This option is not supported by all scanners. .TP .B \-\-image\-emphasis -option sets the image emphasis. Some selection are not available on all scanners. +sets the image emphasis. Some selection are not available on all scanners. .TP .B \-\-gamma -options set the gamma curve. It is only valid for Gray modes, and is not available on all scanners. Gamma downloading is not implemented by the backend. +sets the gamma curve. It is only valid for Gray modes, and is not available on all scanners. Gamma downloading is not implemented by the backend. .SH CONFIGURATION FILE The configuration file .I @CONFIGDIR@/matsushita.conf -supports the device name to use (eg +supports the device name to use (e.g. .IR /dev/scanner ) and the SCSI option to auto-detect the scanners supported. diff --git a/doc/sane-microtek.man b/doc/sane-microtek.man index 674f0bd..be36caa 100644 --- a/doc/sane-microtek.man +++ b/doc/sane-microtek.man @@ -104,7 +104,7 @@ ignored. A sample configuration file is shown below: The configuration file may also contain the special tokens .I norealcal or -.I noprecal. +.IR 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. diff --git a/doc/sane-microtek2.man b/doc/sane-microtek2.man index 45756ed..e2f890e 100644 --- a/doc/sane-microtek2.man +++ b/doc/sane-microtek2.man @@ -7,9 +7,7 @@ The library implements a SANE (Scanner Access Now Easy) backend that provides access to Microtek scanners with a SCSI-2 command set. This backend can be considered alpha to beta. Some scanner models are reported -to work well, others not. New development versions of this backend can be -obtained from -.IR http://karstenfestag.gmxhome.de . +to work well, others not. .PP There exists a different backend for Microtek scanners with SCSI-1 command set. @@ -17,7 +15,7 @@ Refer to .BR sane\-microtek (5) for details. .PP -And there is work in progress for the ScanMaker 3600. +And there is partial progress for the ScanMaker 3600. See .IR http://sourceforge.net/projects/sm3600 . .PP @@ -155,7 +153,9 @@ 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. Note that, except for option dump <n> and -option strip-height <n>, the entry in the microtek2.conf file only enables +option strip-height <n>, the entry in the +.I microtek2.conf +file only enables the corresponding option for being showed in the frontend. There, in the frontend, you can switch the options on and off. Currently the following options are supported: diff --git a/doc/sane-mustek.man b/doc/sane-mustek.man index 45ea2d3..b269678 100644 --- a/doc/sane-mustek.man +++ b/doc/sane-mustek.man @@ -181,7 +181,9 @@ is 128. Because of double buffering the buffer actually sent to the scanner is half the size of this value. Try to increase this value to achieve higher scan speeds. Note that some ScanExpress scanners don't like buffer sizes above 64 kb (buffersize = 128). If your sg driver can't set SCSI buffer sizes at -runtime you may have to change that value, too. See sane\-scsi(5) for details. +runtime you may have to change that value, too. See +.BR sane\-scsi (5) +for details. .PP Option .B blocksize @@ -312,7 +314,7 @@ I/O ports. Thus, either make frontends such as .BR scanimage (1) and .BR xscanimage (1) -setuid root (generally not recommended for safety reasons) or, alternatively, +setuid root (generally not recommended for security reasons) or, alternatively, access this backend through the network daemon .BR saned (8). .PP diff --git a/doc/sane-mustek_pp.man b/doc/sane-mustek_pp.man index 0ab8e41..a69be60 100644 --- a/doc/sane-mustek_pp.man +++ b/doc/sane-mustek_pp.man @@ -100,7 +100,7 @@ Note that the backend needs to run as root or has to have appropriate access rights to .I /dev/parport* if libieee1284 support is compiled in. To allow user -access to the scanner run the backend through the network interface (See +access to the scanner run the backend through the network interface (see .BR saned (8) and .BR sane\-net (5)). @@ -109,15 +109,12 @@ Note also that the backend support .IR "parport sharing" , i.e. if you try printing while scanning, your computer may crash. To enable -parport sharing, you have to enable libieee1284 at compile time. This backend -also conflicts with the -.BR sane\-musteka4s2 (5) -backend. You can only enable one of them in your +parport sharing, you have to enable +.BR libieee1284 (3) +at compile time. +You may also have to enable the backend explicitly in your .IR dll.conf . -However, you have -to enable the backend explicitly in your -.IR dll.conf , -just remove the hash mark in the line "mustek_pp". +Just remove the hash mark in the line "mustek_pp". .SH "DEVICE DEFINITION" This backend allows multiple devices being defined and configured via the diff --git a/doc/sane-mustek_usb.man b/doc/sane-mustek_usb.man index 105228f..ea671ce 100644 --- a/doc/sane-mustek_usb.man +++ b/doc/sane-mustek_usb.man @@ -86,7 +86,7 @@ Instead of using the device name, the scanner can be autodetected by statements which are already included into .IR mustek_usb.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 +support libusb. "vendor_id" and "product_id" are hexadecimal numbers that identify the scanner. If this doesn't work, a device name and the option specifying the scanner type must be placed in .I mustek_usb.conf diff --git a/doc/sane-net.man b/doc/sane-net.man index ee7e82e..14cf704 100644 --- a/doc/sane-net.man +++ b/doc/sane-net.man @@ -93,10 +93,8 @@ are contacted in addition to the hosts listed above. For this backend to function properly, it is also necessary to define the .B sane\-port service in -.IR /etc/services . -The -.B sane -service should be defined using a line of the following form: +.I /etc/services +using a line of the following form: .PP .RS sane\-port 6566/tcp # SANE network scanner daemon diff --git a/doc/sane-p5.man b/doc/sane-p5.man index 80438e8..6216161 100644 --- a/doc/sane-p5.man +++ b/doc/sane-p5.man @@ -28,7 +28,7 @@ This backend expects device names of the form: .RE .PP Where -\fBvalue\fR is : +\fBvalue\fR is: .RS .TP @@ -151,7 +151,9 @@ your .IR @CONFIGDIR@/dll.conf . If your scanner isn't detected, make sure you've defined the right port address, or the correct device -in your p5.conf. +in your +.I p5.conf +file. .TP .I the name of your scanner/vendor also a worthy information. Please also include the optical resolution and lamp type of your diff --git a/doc/sane-pixma.man b/doc/sane-pixma.man index 9811742..ce2ce26 100644 --- a/doc/sane-pixma.man +++ b/doc/sane-pixma.man @@ -19,9 +19,9 @@ Currently, the following models work with this backend: .RS PIXMA E410, E510, E4500 .br -PIXMA G600, G2000, G2010, G2100, G4000, G4511 +PIXMA G600, G2000, G2010, G2030, G2070, G2100, G3030, G3070, G4000, G4070, G4511 .br -PIXMA GX6000, GX7000 +PIXMA GX1000, GX2000, GX3000, GX4000, GX6000, GX6500, GX7000 .br PIXMA MG2100, MG2200, MG2400, MG2500, MG2900, MG3000, MG3100 .br @@ -55,13 +55,15 @@ PIXMA MX410, MX420, MX470, MX510, MX520, MX530, MX700, MX720 .br PIXMA MX850, MX860, MX870, MX882, MX885, MX890, MX920, MX7600 .br +PIXMA TC-20M, TC-5200M +.br PIXMA TR4500, TR4600, TR4700 .br PIXMA TS2400, TS2600, TS3100, TS3300, TS3450, TS3451, TS3452 .br PIXMA TS3500, TS5000, TS5100, TS5350i, TS5400, TS6100, TS6200 .br -PIXMA TS7530, TS7450i ,TS8000, TS8530, TS8200 +PIXMA TS7530, TS7450i ,TS8000, TS8200, TS8530, TS8630, TS8630 .br PIXUS MP10 .br @@ -123,25 +125,27 @@ PIXMA MX320, MX390, MX430, MX450, MX490, MX710 .br PIXMA G3000, G3010, G4010, G6000, G6080, G7000, GM4000, GM4080 .br -PIXMA TR7500, TR7530, TR7600, TR8500, TR8530, TR8580, TR8600 +PIXMA TR7500, TR7530, TR7600, TR7800, TR8500, TR8530, TR8580 TR8600 .br PIXMA TR8630, TR9530 .br PIXMA TS3400, TS5100, TS6000, TS6130, TS6180, TS6230, TS6280, TS6300 .br -PIXMA TS6330, TS6330, TS6380, TS6400, TS7330, TS7400, TS7430, TS8100 +PIXMA TS6330, TS6330, TS6380, TS6400, TS6630, TS6730, TS7330, TS7400, +.br +PIXMA TS7430, TS7600i, TS7700, TS7700A, TS7700i, TS8100, TS8130 .br -PIXMA TS8130, TS8180, TS8230, TS8280, TS8300, TS8330, TS8380, TS9000 +PIXMA TS8180, TS8230, TS8280, TS8300, TS8330, TS8380, TS8700, TS9000 .br PIXMA TS9100, TS9180, TS9500, TS9580 .br -PIXUS MP5, XK50, XK60, XK70, XK80, XK90, XK100, XK500 +PIXUS MP5, XK50, XK60, XK70, XK80, XK90, XK100, XK110, XK120, XK500 .br imageCLASS MF720, MF810/820, MF5630, MF5650, MF5750, MF8170c .br imageCLASS MPC190, D550 .br -i-SENSYS MF110, MF220, MF260, MF410, MF420, MF510, MF520, MF740 +i-SENSYS MF110, MF220, MF260, MF410, MF420, MF510, MF520, MF740, MF750 .br i-SENSYS MF5880dn, MF5900, MF6680dn, MF8500C .br @@ -167,7 +171,7 @@ The backend supports: .br * a custom gamma table, .br -* Automatic Document Feeder, Simplex and Duplex. +* Automatic Document Feeder, Simplex and Duplex, .br * Transparency Unit, 24 or 48 bits depth. Infrared channel on certain models. .RE @@ -183,7 +187,7 @@ where aaaa is the scanners model and bbbb is the hostname or ip-adress. Example: pixma:MF4800_192.168.1.45 is a MF4800 Series multi-function peripheral. .PP This backend, based on cloning original Canon drivers protocols, is in -a production stage. Designed has been carried out without any applicable +a production stage. Design has been carried out without any applicable manufacturer documentation, probably never available. However, we have tested it as well as we could, but it may not work in all situations. You will find an up-to-date status at the project homepage. (See below). @@ -235,8 +239,8 @@ backward compatibility reasons. .TP .I button\-1 button\-2 (read only) These options will return the value of the respective buttons. -value 0 means that the button was not pressed, 1 is returned when the button -was pressed. Some scanners with more than two buttons send the button number +Value 0 means that the button was not pressed, 1 is returned when the button +was pressed. Some scanners, with more than two buttons, send the button number as target. .TP .I original @@ -293,7 +297,7 @@ only scanners that cannot be auto-detected because they are on a different subnet shall be listed here. If you do not use Linux and your OS does not allow enumeration of interfaces (i.e. it does not support the .BR getifaddrs () -qfunction) you also may need +function) you also may need to add your scanner here as well. .PP Scanners shall be listed in the configuration file as follows: @@ -302,48 +306,56 @@ Scanners shall be listed in the configuration file as follows: .I <method>://<host>[:port][/timeout=<value>] .RE .PP -where method indicates the protocol used (bjnp is used for inkjet multi-functionals -and mfnp is used for laser multi-functionals). -.PP -host is the hostname or IP address of the scanner, e.g. bjnp://10.0.1.4 -for IPv4, bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a] for a literal -IPv6-address or bjnp://myscanner.mydomain.org for a hostname. -.PP -The port number is optional and in normally implied by the method. +.TP +.B method +indicates the protocol used. +.I bjnp +is used for inkjet multi-functionals and +.I mfnp +is used for laser multi-functionals). +.TP +.B host +is the hostname or IP address of the scanner, e.g. +.I bjnp://10.0.1.4 +for IPv4, +.I bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a] +for a literal IPv6-address or +.I bjnp://myscanner.mydomain.org +for a hostname. +.TP +.B port +is optional and is normally implied by the method. Port 8610 is the standard port for mfnp, 8612 for bjnp. +.TP +.B timeout +scanner-specific timeout value for the network protocol. The value is in ms. .PP -A scanner specific timeout value for the network protocol can be set using the -bjnp-timeout parameter. The value is in ms. -.PP -Define scanners each on a new line. +Define each scanner each on a separate line. .PP -More globally applicable timeouts can be set using the bjnp-timeout parameter as follows: +More globally-applicable timeouts can be set using the bjnp-timeout parameter as follows: .PP .RS .I bjnp-timeout=<value> .RE .PP A timeout defined using bjnp-timeout will apply to the following scanner definitions -in the file. If required the bjnp-timeout setting +in the file. If required, the bjnp-timeout setting can be defined multiple times, where each setting will apply only to the scanners that -follow the setting. The last setting is used for the auto discovered scanners. +follow the setting. The last setting is used for auto-discovered scanners. If not explicitly set, the default 1000ms setting will apply. .PP Setting timeouts should only be required in exceptional cases. .PP .RE .PP -If so desired networking can be disabled as follows: +If so desired, networking can be disabled as follows: .RS -.IP - -If the first non-commented line contains -.B networking=no -all networking will be disabled. -This will cause all further statements in the configuration file to be ignored. -.IP - -A line that contains -.B auto_detection=no -will cause auto-detection to be skipped. Explicitly defined network scanners will still be probed. +.IP \fInetworking=no\FR +If the first non-commented line contains this entry all networking will be disabled. +All further statements in the configuration file will be ignored. +.IP \fIauto_detection=no\fR +This line will cause auto-detection to be skipped. +Explicitly defined network scanners will still be probed. .SH USB SUPPORT USB scanners will be auto-detected and require no configuration. .SH NETWORKING SUPPORT @@ -446,7 +458,7 @@ the verbosity and includes the information printed at the lower levels. .RE .TP .B PIXMA_EXPERIMENT -Setting to a non-zero value will enable the support for experimental models. +Setting to a non-zero value will enable experimental support for further models. You should also set SANE_DEBUG_PIXMA to 11. .TP .B SANE_CONFIG_DIR diff --git a/doc/sane-plustek.man b/doc/sane-plustek.man index 50e2c6a..568cca4 100644 --- a/doc/sane-plustek.man +++ b/doc/sane-plustek.man @@ -411,7 +411,9 @@ means autocalibration. .RE .PP -See the plustek.conf file for examples. +See the +.I plustek.conf +file for examples. .PP .B Note: .br @@ -475,7 +477,7 @@ export SANE_DEBUG_PLUSTEK=10 .BR sane\-usb (5), .BR sane\-u12 (5), .BR sane\-gt68xx (5), -.BR sane-\mustek_pp (5), +.BR sane\-mustek_pp (5), .BR sane\-find\-scanner (1), .BR scanimage (1) .br @@ -486,24 +488,20 @@ Please send any information and bug-reports to: .br .B SANE Mailing List .PP -Additional info and hints can be obtained from our -.br -Mailing-List archive at: -.br -.I http://www.sane\-project.org/mailing\-lists.html +Additional info and hints can be obtained from our mailing-List archive at: +.IR http://www.sane\-project.org/mailing\-lists.html . .PP To obtain debug messages from the backend, please set the environment-variable .B SANE_DEBUG_PLUSTEK -before calling your favorite scan-frontend (i.e. -.BR scanimage (1)), i.e.: - -.br +before calling your favorite SANE frontend (e.g. +.BR scanimage (1)): +.PP .I export SANE_DEBUG_PLUSTEK=20 ; scanimage .PP -The value controls the verbosity of the backend. Please note, that -values greater than 24 force the backend to output raw data files, -which could be rather large. The ending of these files is ".raw". +The value controls the verbosity of the output. Please note that +values greater than 24 force the backend to output raw data files +which could be rather large. The suffix of these files is ".raw". For problem reports it should be enough the set the verbosity to 13. diff --git a/doc/sane-plustek_pp.man b/doc/sane-plustek_pp.man index 2c73ada..66d465d 100644 --- a/doc/sane-plustek_pp.man +++ b/doc/sane-plustek_pp.man @@ -291,21 +291,18 @@ Please send any information and bug-reports to: .br .B SANE Mailing List .PP -Additional info and hints can be obtained from our -.br -Mailing-List archive at: -.br -.I http://www.sane\-project.org/mailing\-lists.html +Additional info and hints can be obtained from our mailing-List archive at: +.IR http://www.sane\-project.org/mailing\-lists.html . .PP To obtain debug messages from the backend, please set the environment-variable .B SANE_DEBUG_PLUSTEK_PP -before calling your favorite scan-frontend (i.e. -.BR xscanimage (1)), i.e.: -.br +before calling your favorite SANE frontend (e.g. +.BR xscanimage (1)): +.PP .I export SANE_DEBUG_PLUSTEK_PP=20 ; xscanimage .PP -The value controls the verbosity of the backend. +The value controls the verbosity of the output. .PP .SH "KNOWN BUGS & RESTRICTIONS" diff --git a/doc/sane-scsi.man b/doc/sane-scsi.man index 0cd63ca..723b286 100644 --- a/doc/sane-scsi.man +++ b/doc/sane-scsi.man @@ -44,7 +44,7 @@ is the SCSI vendor string, .I MODEL is the SCSI model string, .I TYPE -is type SCSI device type string, +is the SCSI device type string, .I BUS is the SCSI bus number (named "host" in .IR /proc/scsi/scsi ), @@ -195,7 +195,7 @@ maximum buffer size can be changed at program run time, and there is no restrict version 2.2.7 on. If the new SG driver is available some backends (e.g. .BR sane\-umax (5), -.BR sane\-mustek (5) , +.BR sane\-mustek (5), .BR sane\-sharp (5)) automatically request larger SCSI buffers. If a backend does not automatically request a larger SCSI buffer, set @@ -204,9 +204,9 @@ the environment variable to the desired buffer size in bytes. It is not recommended to use more than 1 MB, because for large values the probability increases that the SG driver cannot allocate the necessary buffer(s). For ISA cards, even -1 MB might be a too large value. For a detailed discussion of memory -issues of the SG driver, see -.I http://www.torque.net/sg. +1 MB might be a too large value. +For a detailed discussion of the Linux SG SCSI driver see: +.IR https://tldp.org/HOWTO/SCSI-Generic-HOWTO . .PP For Linux kernels before version 2.2.7 the size of the buffer is only 32KB. This works, but for many cheaper scanners this causes scanning to be slower by @@ -299,7 +299,7 @@ of the form ``restart (ncr dead ?)'' in your .I /var/log/messages file or on the system console, it's an indication that the timeout is too short. In this case, find the line ``if (np->latetime>10)'' in file -.I ncr53c8xx. +.I ncr53c8xx.c (normally in directory .IR /usr/src/linux/drivers/scsi ) and change the constant 10 to, say, 60 (one minute). @@ -329,7 +329,7 @@ and with target-id 0 would be called .IR /dev/sg0a , and the device with target-id 1 on that same bus would be called -.IR /dev/sg0b, +.IR /dev/sg0b , and so on. .SH ENVIRONMENT diff --git a/doc/sane-sharp.man b/doc/sane-sharp.man index 34ad8cb..b26ecb5 100644 --- a/doc/sane-sharp.man +++ b/doc/sane-sharp.man @@ -98,7 +98,7 @@ default selection. .TP .B \-\-custom\-gamma -Custom Gamma This option determines whether a builtin or a custom +Custom Gamma. This option determines whether a builtin or a custom gamma table is used. Possible settings are: .I yes (enables custom gamma tables) or @@ -197,7 +197,7 @@ This option is only available in scan mode .TP .B \-\-threshold-red -Sets the threshold for the red component of a pixel in +Sets the threshold for the red component of a pixel in lineart color scan mode. Possible values are 1..255. The default value is 128. This option is only available in scan mode color @@ -205,7 +205,7 @@ This option is only available in scan mode color .TP .B \-\-threshold-green -Sets the threshold for the green component of a pixel in +Sets the threshold for the green component of a pixel in lineart color scan mode. Possible values are 1..255. The default value is 128. This option is only available in scan mode color @@ -213,7 +213,7 @@ This option is only available in scan mode color .TP .B \-\-threshold-blue -Sets the threshold for the blue component of a pixel in +Sets the threshold for the blue component of a pixel in lineart color scan mode. Possible values are 1..255. The default value is 128. This option is only available in scan mode color @@ -321,11 +321,11 @@ stops. Stops of the carriage can be caused by the following reasons: .PP .RS -\- too much "traffic" on the SCSI bus +\- too much "traffic" on the SCSI bus, .br \- slow responses by the backend to the scanner, .br -\- a program which processes the data acquired by the backend too slow. +\- a program which processes the data acquired by the backend is too slow. .PP .RE Too much "traffic" on the SCSI bus: This happens for example, if hard disks @@ -409,12 +409,12 @@ backend. At present, the scanner must power off and on to stop this annoying behaviour. .RE -2. Threshold level does not work (only JX-610) +2. Threshold level does not work (only JX\-610) .PP -3. The maximum resolution is limited to 600 dpi(JX-610 supported -to 1200 dpi) resp. 400 dpi (JX-250) +3. The maximum resolution is limited to 600 dpi (JX\-610 supported +to 1200 dpi) resp. 400 dpi (JX\-250) .PP -4. If the JX250 is used with an ADF, the following situation can occur: After +4. If the JX\-250 is used with an ADF, the following situation can occur: After several scans, the scanner moves, after loading a new sheet of paper, the carriage to the idle position, and then back to the position used for ADF scans. This happens for @@ -436,8 +436,8 @@ tested. Kazuya Fukuda, Abel Deuring .SH CREDITS -The Sharp backend is based on the Canon backend written by Helmut Koeberle +The Sharp backend is based on the Canon backend written by Helmut Koeberle. .PP Parts of this man page are a plain copy of .BR sane\-mustek (5) -by David Mosberger-Tang, Andreas Czechanowski and Andreas Bolsch +by David Mosberger-Tang, Andreas Czechanowski and Andreas Bolsch. diff --git a/doc/sane-stv680.man b/doc/sane-stv680.man index 58488e0..9123871 100644 --- a/doc/sane-stv680.man +++ b/doc/sane-stv680.man @@ -82,7 +82,7 @@ scanimage \-\-help \-d stv680 .TP .B \-\-mode -selects the basic mode of operation of the webcams valid choices. +selects the basic mode of operation of the webcam's valid choices. The read resolution mode is 8 bits, output resolution is 24 bits. Selects the resolution for a scan. @@ -113,7 +113,7 @@ value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1. .TP .B \-\-white\-level\-g \-32..+32 Selects what green radiance level should be -considered "white", when scanning some sheets by changing the calibration i +considered "white", when scanning some sheets by changing the calibration value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1. .TP diff --git a/doc/sane-teco2.man b/doc/sane-teco2.man index 6fd9780..2532cf1 100644 --- a/doc/sane-teco2.man +++ b/doc/sane-teco2.man @@ -94,7 +94,7 @@ For a restricted set of resolutions are available. .B Note: -All values with ydpi > 300 (300 x 600) or 600 (600 x 1200) result in +All values with vertical resolution in dpi > 300 (300 x 600) or 600 (600 x 1200) result in a wrong proportion for the scan. The proportion can be adjusted with the following .BR convert (1) diff --git a/doc/sane-test.man b/doc/sane-test.man index c456ed5..432f0d6 100644 --- a/doc/sane-test.man +++ b/doc/sane-test.man @@ -235,7 +235,7 @@ constraint. Minimum is 4, maximum 192, and quant is 2. .PP Option .B int\-constraint\-array\-constraint\-word\-list -(6/7) is an int test option with unit percent and using an array a word list +(6/7) is an int test option with unit percent and using an array or word list constraint. .PP Option @@ -258,7 +258,7 @@ set. Minimum is \-42.17, maximum 32767.9999, and quant is 2.0. .PP Option .B fixed\-constraint\-word\-list -(3/3) is a Fixed test option with no unit and constraint word list set. +(3/3) is a fixed test option with no unit and constraint word list set. .PP .SH STRING TEST OPTIONS diff --git a/doc/sane-u12.man b/doc/sane-u12.man index 81ab725..25c8689 100644 --- a/doc/sane-u12.man +++ b/doc/sane-u12.man @@ -167,20 +167,15 @@ Please send any information and bug-reports to: .br .B SANE Mailing List .PP -Additional info and hints can be obtained from our -.br -Mailing-List archive at: -.br -.I http://www.sane\-project.org/mailing\-lists.html +Additional info and hints can be obtained from our mailing-List archive at: +.IR http://www.sane\-project.org/mailing\-lists.html . .PP To obtain debug messages from the backend, please set the environment-variable .B SANE_DEBUG_U12 -before calling your favorite scan-frontend (i.e. -.BR xscanimage (1)), -i.e.: - -.br +before calling your favorite SANE frontend (e.g. +.BR xscanimage (1)): +.PP .I export SANE_DEBUG_U12=20 ; xscanimage .PP The value controls the verbosity of the backend. diff --git a/doc/sane-umax_pp.man b/doc/sane-umax_pp.man index 7bfa750..fdb076a 100644 --- a/doc/sane-umax_pp.man +++ b/doc/sane-umax_pp.man @@ -55,15 +55,15 @@ if you have a kernel with ppdev support. .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 +run the backend through the network interface (see .BR saned (8) and .BR sane\-net (5)). A more relaxed solution (security wise) is to add suid bit to the frontend -(See +(see .BR chmod (1)). -The backend drop root privileges as soon as it can, right after gaining direct -access to IO ports, which lessen risks when being root. +The backend drops root privileges as soon as it can, right after gaining direct +access to I/O ports, which lessen risks of being root. .SH "DEVICE NAMES" This backend expects device names of the form: @@ -73,7 +73,7 @@ This backend expects device names of the form: .RE .PP Where -\fBvalue\fR is : +\fBvalue\fR is: .RS .TP @@ -102,8 +102,8 @@ have to use .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 +address. Usual values are 0x378, 0x278, 0x3BC. +In this case, you have to run the backend as root (*BSD and Linux), or with 'IOPL=yes' on OS/2 .PP @@ -166,8 +166,7 @@ user provided values. .PP Options -.B red\-offset -, +.BR red\-offset , .B green\-offset and .B blue\-offset diff --git a/doc/sane-usb.man b/doc/sane-usb.man index ea4ee01..a885ee8 100644 --- a/doc/sane-usb.man +++ b/doc/sane-usb.man @@ -54,7 +54,9 @@ scanner under Linux) or disable the driver when compiling a new kernel. For Linux, your kernel needs support for the USB filesystem (usbfs). For kernels older than 2.4.19, replace "usbfs" with "usbdevfs" because the name has changed. This filesystem must be mounted. That's done automatically at boot -time, if /etc/fstab contains a line like this: +time, if +.I /etc/fstab +contains a line like this: .PP .RS none /proc/bus/usb usbfs defaults 0 0 @@ -97,7 +99,9 @@ For the .BR BSDs , the device files used by libusb are named .IR /dev/ugen* . -Use chmod to apply appropriate permissions. +Use +.BR chmod (1) +to apply appropriate permissions. .SH "SANE ISSUES" .PP @@ -174,6 +178,15 @@ setting the environment variable to 1. This may work around issues which happen with particular kernel versions. Example: .I export SANE_USB_WORKAROUND=1. +.TP +.B SANE_XEROX_USB_HALT_WORKAROUND +If your old (pre-2010) Xerox / Samsung / HP scanner is detected +only once and subsequent usage requires replugging the cable, try +setting the environment variable +.B SANE_XEROX_USB_HALT_WORKAROUND +to 1. This may work around issues which happen with particular USB +controllers. Example: +.I export SANE_XEROX_USB_HALT_WORKAROUND=1. .SH "SEE ALSO" .BR sane (7), diff --git a/doc/sane.man b/doc/sane.man index a37e8d2..701e3ea 100644 --- a/doc/sane.man +++ b/doc/sane.man @@ -61,7 +61,7 @@ homepage. .SH "GENERAL INFORMATION" The following sections provide short descriptions and links to more information about several aspects of -.B SANE. +.BR SANE . A name with a number in parenthesis (e.g. .BR sane\-dll (5)) points to a manual page. In this case @@ -367,6 +367,11 @@ Supports the Lexmark X1100 series of USB scanners. See .BR sane\-lexmark (5) for details. .TP +.B lexmark_x2600 +Supports the Lexmark X2600 series of USB scanners. See +.BR sane\-lexmark_x2600 (5) +for details. +.TP .B ma1509 Supports the Mustek BearPaw 1200F USB flatbed scanner. See .BR sane\-ma1509 (5) @@ -818,7 +823,7 @@ So now scanning with works and you want to use one of the graphical frontends like .BR xsane (1) , .BR xscanimage (1) ", or" -.B quiteinsane (1) +.BR quiteinsane (1) but those frontends don't detect your scanner? One reason may be that you installed two versions of .BR SANE . @@ -905,6 +910,7 @@ for details). .BR sane\-kodak (5), .BR sane\-leo (5), .BR sane\-lexmark (5), +.BR sane\-lexmark_x2600 (5), .BR sane\-ma1509 (5), .BR sane\-matsushita (5), .BR sane\-microtek2 (5), diff --git a/doc/saned.man b/doc/saned.man index d91f817..400ab6c 100644 --- a/doc/saned.man +++ b/doc/saned.man @@ -24,6 +24,9 @@ saned \- SANE network daemon .B ] .B [ \-e ] .B [ \-h ] +.B [ \-B +.I buffer-size +.B ] .SH DESCRIPTION .B saned @@ -115,33 +118,15 @@ will divert debug output to stderr instead of the syslog default. .TP +.BR \-B ", " \-\-buffer-size=\fIbuffer\-size\fR +specifies the size of the read buffer used for communication with the backend in KB. +Default value is 1MB. + +.TP .BR \-h ", " \-\-help displays a short help message. -.PP -If -.B saned -is run from other programs such as -.BR inetd (8), -.BR xinetd (8) -and -.BR systemd (1), -check that program's documentation on how to pass command-line options. .SH CONFIGURATION -First and foremost: -.B saned -is not intended to be exposed to the internet or other non-trusted -networks. Make sure that access is limited by tcpwrappers and/or a firewall -setup. Don't depend only on -.BR saned 's -own authentication. Don't run -.B saned -as root if it's not necessary. And do -.B not -install -.B saned -as setuid root. -.PP The .I saned.conf configuration file contains both options for the daemon and the access @@ -199,282 +184,6 @@ scan\-client.somedomain.firm .PP The case of the host names does not matter, so AHost.COM is considered identical to ahost.com. -.SH SERVER DAEMON CONFIGURATION -For -.B saned -to work properly in its default mode of operation, it is also necessary to -add the appropriate configuration for -.BR xinetd (8), -.BR inetd (8) -or -.BR systemd (1) -(see below). -Note that your -.BR inetd (8) -must support IPv6 if you want to connect to -.B saned -over IPv6; -.BR xinetd (8), -.BR openbsd-inetd (8) -and -.BR systemd (1) -are known to support IPv6, check the documentation for your -.BR inetd (8) -daemon. -.PP -In the sections below the configuration for -.BR inetd (8), -.BR xinetd (8) -and -.BR systemd (1) -are described in more detail. -.PP -For the configurations below it is necessary to add a line of the following -form to -.IR /etc/services : -.PP -.RS -sane\-port 6566/tcp # SANE network scanner daemon -.RE -.PP -The official IANA short name for port 6566 is "sane\-port". The older name -"sane" is now deprecated. - -.SH INETD CONFIGURATION -It is required to add a single line to the -.BR inetd (8) -configuration file -.IR (/etc/inetd.conf) -. -.PP -The configuration line normally looks like this: -.PP -.RS -sane\-port stream tcp nowait saned.saned @SBINDIR@/saned saned -.RE -.PP -However, if your system uses -.BR tcpd (8) -for additional security screening, you may want to disable -.B saned -access control by putting ``+'' in -.IR saned.conf -and use a line of the following form in -.IR /etc/inetd.conf -instead: -.PP -.RS -sane\-port stream tcp nowait saned.saned /usr/sbin/tcpd @SBINDIR@/saned -.RE -.PP -Note that both examples assume that there is a -.B saned -group and a -.B saned -user. If you follow this example, please make sure that the -access permissions on the special device are set such that -.B saned -can access the scanner (the program generally needs read and -write access to scanner devices). - -.SH XINETD CONFIGURATION -If -.BR xinetd (8) -is installed on your system instead of -.BR inetd (8) -the following example for -.I /etc/xinetd.conf -may be helpful: -.PP -.RS -.ft CR -.nf -# default: off -# description: The sane server accepts requests -# for network access to a local scanner via the -# network. -service sane\-port -{ - port = 6566 - socket_type = stream - wait = no - user = saned - group = saned - server = @SBINDIR@/saned -} -.fi -.ft R -.RE - -.SH SYSTEMD CONFIGURATION -.B saned -can be compiled with explicit -.BR systemd (1) -support. This -will allow logging debugging information to be forwarded -to the -.BR systemd (1) -journal. The -.BR systemd (1) -support requires compilation with the systemd-devel package -installed on the system. This is the preferred option. - -.B saned -can be used with -.BR systemd (1) -without the -.BR systemd (1) -integration compiled in, but then logging of debug information is not supported. - -The -.BR systemd (1) -configuration is different for the 2 options, so both are described below. - -.SH Systemd configuration for saned with systemd support compiled in -For -.BR systemd (1) -configuration we need to add 2 configuration files in -.IR /etc/systemd/system . -.PP -The first file we need to add here is called -.I saned.socket. -It shall have -the following contents: -.PP -.RS -.ft CR -.nf -[Unit] -Description=saned incoming socket - -[Socket] -ListenStream=6566 -Accept=yes -MaxConnections=1 - -[Install] -WantedBy=sockets.target -.fi -.ft R -.RE -.PP -The second file to be added is -.I saned@.service -with the following contents: -.PP -.RS -.ft CR -.nf -[Unit] -Description=Scanner Service -Requires=saned.socket - -[Service] -ExecStart=/usr/sbin/saned -User=saned -Group=saned -StandardInput=null -StandardOutput=syslog -StandardError=syslog -Environment=SANE_CONFIG_DIR=@CONFIGDIR@ -# If you need to debug your configuration uncomment the next line and -# change it as appropriate to set the desired debug options -# Environment=SANE_DEBUG_DLL=255 SANE_DEBUG_BJNP=5 - -[Install] -Also=saned.socket -.fi -.ft R -.RE -.PP -You need to set an environment variable for -.B SANE_CONFIG_DIR -pointing to the directory where -.B saned -can find its configuration files. -You will have to remove the # on the last line and set the variables -for the desired debugging information if required. Multiple variables -can be set by separating the assignments by spaces as shown in the -example above. -.PP -Unlike -.BR xinetd (8) -and -.BR inetd (8), -.BR systemd (1) -allows debugging output from backends set using -.B SANE_DEBUG_XXX -to be captured. See the man-page for your backend to see what options -are supported. -With the service unit as described above, the debugging output is -forwarded to the system log. - -.SH Systemd configuration when saned is compiled without systemd support -This configuration will also work when -.B saned -is compiled WITH -.BR systemd (1) -integration support, but it does not allow debugging information to be logged. -.PP -For -.BR systemd (1) -configuration for -.BR saned , -we need to add 2 configuration files in -.IR /etc/systemd/system . -.PP -The first file we need to add here is called -.I saned.socket. -It is identical to the version for -.BR systemd (1) -with the support compiled in. -It shall have the following contents: -.PP -.RS -.ft CR -.nf -[Unit] -Description=saned incoming socket - -[Socket] -ListenStream=6566 -Accept=yes -MaxConnections=1 - -[Install] -WantedBy=sockets.target -.fi -.ft R -.RE -.PP -The second file to be added is -.IR saned@.service . -This one differs from the version with -.BR systemd (1) -integration compiled in: -.PP -.RS -.ft CR -.nf -[Unit] -Description=Scanner Service -Requires=saned.socket - -[Service] -ExecStart=/usr/sbin/saned -User=saned -Group=saned -StandardInput=socket - -Environment=SANE_CONFIG_DIR=/etc/sane.d - -[Install] -Also=saned.socket -.fi -.ft R -.RE -.PP - .SH FILES .TP .I /etc/hosts.equiv @@ -518,6 +227,28 @@ and .I "@CONFIGDIR@" being searched (in this order). +.SH NOTES +.B saned +does +.I not +provide confidentiality when communicating with clients. If +.B saned +is exposed directly on the network, other users may be able to intercept +scanned images, or learn passwords for connecting to +.BR saned , +with little effort. Client systems should connect to +.B saned +through a secure tunnel to the server instead. +.PP +.B saned +is not a trusted program and should not run with root privileges. +.PP +Refer to +.I @DOCDIR@/saned/saned.install.md +for details on configuring +.B saned +as a service. + .SH "SEE ALSO" .BR sane (7), .BR scanimage (1), diff --git a/doc/saned/saned.install.md b/doc/saned/saned.install.md new file mode 100644 index 0000000..ba40a82 --- /dev/null +++ b/doc/saned/saned.install.md @@ -0,0 +1,59 @@ +Configuring `saned` as a service +================================ + +To launch `saned` automatically in response to an incoming connection, +configure it as a service managed by `inetd`, `xinetd`, or `systemd`. + +First verify that /etc/services contains a line of the following form: + + sane-port 6566/tcp # SANE network scanner daemon + +If not, then add it. (The name "sane-port" has been assigned by IANA.) + + +The examples below assume there is a "saned" group and a "saned" user. +Make sure that the ACLs on the scanner device files are set such that +`saned` can access them for reading and writing. + + +`inetd` Configuration +--------------------- + +Configure `inetd` if your platform does not use `systemd` or `xinetd`. +Not all `inetd` implementations support IPv6; check its documentation. + +Add a line in /etc/inetd.conf like the following: + + sane-port stream tcp nowait saned.saned /usr/local/sbin/saned saned + + +`xinetd` Configuration +---------------------- + +Copy frontend/saned.xinetd.conf into the `xinetd` configuration files +directory (as /etc/xinetd.d/saned.conf). + + +`systemd` Configuration +----------------------- + +Copy frontend/saned.socket and frontend/saned@.service into one of the +system-wide directories for unit files (/etc/systemd/system/). + +The recommended way to adjust the service settings is with the command +`systemctl edit saned@`. This opens a file inside a text editor where +overrides may be entered. As an example, environment variables can be +set which are used to control debug logging in individual backends: + + [Service] + Environment=SANE_DEBUG_DLL=255 + Environment=SANE_DEBUG_BJNP=5 + +(Refer to the man pages of the appropriate backends for more details.) + +It is recommended to build SANE with explicit `systemd` support, which +allows log messages from `saned` to be written to the journal. If SANE +is built without this support, the following override must be used: + + [Service] + StandardInput=socket diff --git a/doc/scanimage.man b/doc/scanimage.man index a86fe2a..710b8f3 100644 --- a/doc/scanimage.man +++ b/doc/scanimage.man @@ -4,36 +4,32 @@ scanimage \- scan an image .SH SYNOPSIS .B scanimage -.RB [ \-d | \-\-device\-name +.RB [ \-d .IR dev ] -.RB [ \-\-format -.IR format ] -.RB [ \-i | \-\-icc\-profile +.RB [ \-\-format\fI=output-format ] +.RB [ \-i .IR profile ] -.RB [ \-L | \-\-list\-devices ] -.RB [ \-f | \-\-formatted\-device\-list -.IR format ] -.RB [ \-b | \-\-batch +.RB [ \-L ] +.RB [ \-f +.IR device-format ] +.RB [ \-b .RI [ format ]] -.RB [ \-\-batch\-start -.IR start ] -.RB [ \-\-batch\-count -.IR count ] -.RB [ \-\-batch\-increment -.IR increment ] +.RB [ \-\-batch\-start\fI=start ] +.RB [ \-\-batch\-count\fI=count ] +.RB [ \-\-batch\-increment\fI=increment ] .RB [ \-\-batch\-double ] .RB [ \-\-accept\-md5\-only ] -.RB [ \-p | \-\-progress ] -.RB [ \-o | \-\-output-file +.RB [ \-p] +.RB [ \-o .IR path ] -.RB [ \-n | \-\-dont\-scan ] -.RB [ \-T | \-\-test ] -.RB [ \-A | \-\-all-options ] -.RB [ \-h | \-\-help ] -.RB [ \-v | \-\-verbose ] -.RB [ \-B | \-\-buffer-size -.RI [= size ]] -.RB [ \-V | \-\-version ] +.RB [ \-n ] +.RB [ \-T ] +.RB [ \-A ] +.RB [ \-h ] +.RB [ \-v ] +.RB [ \-B +.RI size ] +.RB [ \-V ] .RI [ device\-specific\-options ] .SH DESCRIPTION .B scanimage @@ -96,9 +92,9 @@ control of the backend code. .PP Parameters are separated by a blank from single-character options (e.g. -.BI "\-d " epson ) +.BI "\-d " epson \fR) and by a "=" from multi-character options (e.g. -.BR \-\-device\-name =\fIepson\FR ). +.BR \-\-device\-name =\fIepson \fR). .TP .BR \-d "\fI dev\fR, " \-\-device\-name =\fIdev\fR @@ -117,12 +113,12 @@ If this variable is not set, will attempt to open the first available device. .TP -.BR \-\-format =\fIformat\fR +.BR \-\-format =\fIoutput-format\fR selects how image data is written to standard output or the file specified by the .B \-\-output\-file option. -.I format +.I output-format can be .BR pnm , .BR tiff , @@ -150,8 +146,8 @@ by its full device name. You may need to consult your system administrator to find out the names of such devices. .TP -.BR \-f "\fI format\fR, " \-\-formatted\-device\-list =\fIformat\fR -works similar to +.BR \-f "\fI format\fR, " \-\-formatted\-device\-list =\fIdevice-format\fR +works similarly to .BR \-\-list\-devices , but requires a format string. .B scanimage @@ -232,7 +228,7 @@ is a specific command provided to aid this. .B \-\-batch\-double will automatically set the increment to 2. Equivalent to -.BR \-\-batch\-increment =2 +.BR \-\-batch\-increment =2. .TP .B \-\-batch\-prompt @@ -301,17 +297,15 @@ standard output and no scan will be performed. .TP .BR \-v ", " \-\-verbose increases the verbosity of the output of -.B scanimage. +.BR scanimage . The option may be specified repeatedly, each time increasing the verbosity level. .TP -.BR \-B " [\fIsize\fR], " \-\-buffer\-size =[\fIsize\fR] -changes input buffer size from the default of 32KB to -.I size -KB. If +.BR \-B " [\fIsize\fR], " \-\-buffer\-size =\fIsize +changes input buffer size from the default of 1MB to .I size -is not specified then the buffer is set to 1 MB. +KB. .TP .BR \-V ", " \-\-version @@ -325,7 +319,7 @@ loads. If more information about the version numbers of the backends are necessary, the .B DEBUG variable for the dll layer can be used. Example: -.I "SANE_DEBUG_DLL=3 scanimage \-L" . +.IR "SANE_DEBUG_DLL=3 scanimage \-L" . .PP As you might imagine, much of the power of .B scanimage @@ -507,8 +501,8 @@ to 127 characters. .BR sane (7), .BR gamma4scanimage (1), .BR xscanimage (1), -.BR xcam (1) , -.BR xsane (1) , +.BR xcam (1), +.BR xsane (1), .BR scanadf (1), .BR sane\-dll (5), .BR sane\-net (5), |