diff options
Diffstat (limited to 'doc')
138 files changed, 3775 insertions, 2274 deletions
diff --git a/doc/backend-writing.txt b/doc/backend-writing.txt index 5823661..cb2a971 100644 --- a/doc/backend-writing.txt +++ b/doc/backend-writing.txt @@ -185,7 +185,7 @@ sane-backends/include/ used by several backends. * sanei_*: Sanei (SANE internal) headers. Needed for code used in several backends - like USB access. For more details, see the documentaion on the SANE website. + like USB access. For more details, see the documentation on the SANE website. sane-backends/japi/ Contains Java interface for SANE. See README.JAVA for details. @@ -199,7 +199,7 @@ sane-backends/po/ sane-backends/sanei/ Sanei (SANE internal) code. Needed for code used in several backends - like USB access. For more details, see the documentaion on the SANE + like USB access. For more details, see the documentation on the SANE website. sane-backends/testsuite/ @@ -310,7 +310,7 @@ PROGRAMMING the doc/ directory. * Initialize global variables explicitly in sane_init. Keep in mind that - sane_init can be called more than once (if sane_exit is called everytime + sane_init can be called more than once (if sane_exit is called every time after sane_init). Therefore don't depend on automatic initialization to 0 / NULL. diff --git a/doc/descriptions-external/epkowa.desc b/doc/descriptions-external/epkowa.desc index 5bc43bf..78769cb 100644 --- a/doc/descriptions-external/epkowa.desc +++ b/doc/descriptions-external/epkowa.desc @@ -15,11 +15,7 @@ ;;; See the GNU General Public License for more details. ;;; ;;; You should have received a verbatim copy of the GNU General Public -;;; License along with this program; if not, write to: -;;; -;;; Free Software Foundation, Inc. -;;; 59 Temple Place, Suite 330 -;;; Boston, MA 02111-1307 USA +;;; License. If not, see <https://www.gnu.org/licenses/>. ;;; This list of devices has been compiled using the following sources: ;;; diff --git a/doc/descriptions-external/scangearmp2.desc b/doc/descriptions-external/scangearmp2.desc index d3ea973..c82aa40 100644 --- a/doc/descriptions-external/scangearmp2.desc +++ b/doc/descriptions-external/scangearmp2.desc @@ -28,6 +28,105 @@ ; Canon MFP2 conf file ; +; ---- V410 -------------------------- +:model "TS3400 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18b7" +:status :good + +:model "E3400 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18b8" +:status :good + +:model "TR7000 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18b9" +:status :good + +:model "G2020 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18bd" +:status :good + +:model "G3060 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18c3" +:status :good + +:model "G2060 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18c1" +:status :good + +:model "G3020 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18bf" +:status :good + +:model "TS7430 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18b2" +:status :good + +:model "XK90 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18b6" +:status :good + +:model "TS8430 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18b5" +:status :good + +:model "TR7600 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18aa" +:status :good + +:model "TR8600 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18ad" +:status :good + +:model "TR8630 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18af" +:status :good + +:model "TS6400 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18a9" +:status :good + +:model "TS7400 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x18a9" +:status :good + + +; ---- V400 -------------------------- +:model "G7000 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1863" +:status :good + +:model "G7080 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1864" +:status :good + +:model "GM4000 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x1869" +:status :good + +:model "GM4080 series" +:interface "USB WiFi" +:usbid "0x04a9" "0x186a" +:status :good + + ; ---- V390 -------------------------- :model "G6000 series" :interface "USB WiFi" diff --git a/doc/descriptions-external/utsushi.desc b/doc/descriptions-external/utsushi.desc index 231711d..eb5462f 100644 --- a/doc/descriptions-external/utsushi.desc +++ b/doc/descriptions-external/utsushi.desc @@ -1,5 +1,5 @@ ;;; utsushi.desc -*- emacs-lisp -*- (sort of) -;;; Copyright (C) 2015-2019 Olaf Meeuwissen +;;; Copyright (C) 2015-2021 Olaf Meeuwissen ;;; ;;; License: GPL-3.0+ ;;; Author : Olaf Meeuwissen @@ -192,6 +192,16 @@ :usbid "0x04b8" "0x1106" :status :good +:model "ET-2600" +:interface "USB" +:usbid "0x04b8" "0x1122" +:status :good + +:model "ET-2720" +:interface "USB" +:usbid "0x04b8" "0x1157" +:status :good + :model "ET-3750" :interface "USB" :usbid "0x04b8" "0x1130" @@ -282,6 +292,16 @@ :usbid "0x04b8" "0x112e" :status :good +:model "RR-60" +:interface "USB" +:status :good +:comment "USB ID 0x018b or 0x018c" + +:model "RR-70W" +:interface "USB" +:status :good +:comment "USB ID 0x018b or 0x018c" + :model "WF-2850" :interface "USB" :usbid "0x04b8" "0x1138" @@ -445,25 +465,25 @@ :interface "USB" :usbid "0x04b8" "0x0165" :status :good -:comment "propably one of DS-410, DS-535, DS-575W, DS-775" +:comment "probably one of DS-410, DS-535, DS-575W, DS-775" :model "PID 0167" :interface "USB" :usbid "0x04b8" "0x0167" :status :good -:comment "propably one of DS-410, DS-535, DS-575W, DS-775" +:comment "probably one of DS-410, DS-535, DS-575W, DS-775" :model "PID 0168" :interface "USB" :usbid "0x04b8" "0x0168" :status :good -:comment "propably one of DS-410, DS-535, DS-575W, DS-775" +:comment "probably one of DS-410, DS-535, DS-575W, DS-775" :model "PID 0169" :interface "USB" :usbid "0x04b8" "0x0169" :status :good -:comment "propably one of DS-410, DS-535, DS-575W, DS-775" +:comment "probably one of DS-410, DS-535, DS-575W, DS-775" :model "PID 016B" :interface "USB" @@ -475,13 +495,13 @@ :interface "USB" :usbid "0x04b8" "0x016d" :status :good -:comment "propably one of ES-55R, ES-65WR" +:comment "probably one of ES-55R, ES-65WR" :model "PID 016F" :interface "USB" :usbid "0x04b8" "0x016f" :status :good -:comment "propably one of ES-55R, ES-65WR" +:comment "probably one of ES-55R, ES-65WR" :model "PID 0176" :interface "USB" @@ -585,6 +605,7 @@ :interface "USB" :usbid "0x04b8" "0x1122" :status :good +:comment "ET-2600" :model "PID 1123" :interface "USB" @@ -870,7 +891,7 @@ :interface "USB" :usbid "0x04b8" "0x1157" :status :good -:comment "L3xxx" +:comment "ET-2720, L3xxx" :model "PID 1158" :interface "USB" diff --git a/doc/descriptions/avision.desc b/doc/descriptions/avision.desc index 780d7e6..b694e89 100644 --- a/doc/descriptions/avision.desc +++ b/doc/descriptions/avision.desc @@ -89,6 +89,18 @@ :comment "sheetfed scanner" :status :complete +:model "AV186+" +:interface "USB" +:usbid "0x0638" "0x1a33" +:comment "sheetfed scanner" +:status :good + +:model "AV188" +:interface "USB" +:usbid "0x0638" "0x2ad9" +:comment "sheetfed scanner" +:status :untested + :model "AV210D2+" :interface "USB" :usbid "0x0638" "0x1a35" diff --git a/doc/descriptions/canon_dr.desc b/doc/descriptions/canon_dr.desc index a767cdb..d43b1ea 100644 --- a/doc/descriptions/canon_dr.desc +++ b/doc/descriptions/canon_dr.desc @@ -11,9 +11,9 @@ :backend "canon_dr" ; name of backend :url "http://www.thebility.com/canon/" -:version "57" ; version of backend +:version "60" ; version of backend :manpage "sane-canon_dr" ; name of manpage (if it exists) -:comment "Backend updated for SANE release 1.0.28, see sane-canon_dr manpage" +:comment "Backend updated for SANE release 1.0.32, see sane-canon_dr manpage" :devicetype :scanner ; start of a list of devices.... ; other types: :stillcam, :vidcam, ; :meta, :api @@ -268,7 +268,8 @@ :model "DR-C120" :interface "USB" :usbid "0x1083" "0x1651" -:status :untested +:status :basic +:comment "Gray and color work, may always scan in duplex, lower edge may be cropped" :model "DR-C125" :interface "USB" @@ -279,12 +280,13 @@ :interface "USB" :usbid "0x1083" "0x164a" :status :untested +:comment "May be compatible with DR-C120" :model "DR-C225" :interface "USB" :usbid "0x1083" "0x1658" -:status :untested -:comment "" +:status :basic +:comment "Calibration is poor, grayscale mode may crash. DR-C225ii is the same device." :model "DR-F120" :interface "USB" diff --git a/doc/descriptions/canon_lide70.desc b/doc/descriptions/canon_lide70.desc index 6b50fe4..3c1dc64 100644 --- a/doc/descriptions/canon_lide70.desc +++ b/doc/descriptions/canon_lide70.desc @@ -24,6 +24,21 @@ ;================================================== :model "CanoScan LiDE 70" :interface "USB" +:url "http://www.juergen-ernst.de/info_sane.html" :usbid "0x04a9" "0x2225" :status :basic :comment "Please test!" + +:model "CanoScan LiDE 600" +:interface "USB" +:url "http://www.juergen-ernst.de/info_sane.html" +:usbid "0x04a9" "0x2224" +:status :basic +:comment "Please test!" + +:model "CanoScan LiDE 600F" +:interface "USB" +:url "http://www.juergen-ernst.de/info_sane.html" +:usbid "0x04a9" "0x2224" +:status :basic +:comment "Please test!" diff --git a/doc/descriptions/dmc.desc b/doc/descriptions/dmc.desc index 08a01bb..5f14fe6 100644 --- a/doc/descriptions/dmc.desc +++ b/doc/descriptions/dmc.desc @@ -1,5 +1,3 @@ -; $Id$ -; ; SANE Backend specification file (Matto Marjanovic's format) ; ; It's basically emacs-lisp --- so ";" indicates comment to end of line. diff --git a/doc/descriptions/epson2.desc b/doc/descriptions/epson2.desc index d1f3bed..1af191f 100644 --- a/doc/descriptions/epson2.desc +++ b/doc/descriptions/epson2.desc @@ -528,6 +528,11 @@ :status :good :comment "network interface supported via DFSG non-free iscan-network-nt package" +:model "ET-2600" +:interface "USB" +:usbid "0x04b8" "0x1122" +:status :good + :model "ET-2650" :interface "USB Ethernet" :usbid "0x04b8" "0x1121" @@ -1745,12 +1750,14 @@ :model "Perfection 1640SU" ; command spec :interface "SCSI USB" +:scsi "EPSON" "Perfection1640" "processor" :usbid "0x04b8" "0x010a" :status :complete :comment "overseas version of the GT-8700" :model "Perfection 1640SU PHOTO" :interface "SCSI USB" +:scsi "EPSON" "Perfection1640" "processor" :usbid "0x04b8" "0x010a" :status :good :comment "overseas version of the GT-8700F" diff --git a/doc/descriptions/escl.desc b/doc/descriptions/escl.desc index 798f906..88f0fdb 100644 --- a/doc/descriptions/escl.desc +++ b/doc/descriptions/escl.desc @@ -13,9 +13,19 @@ :status :good :comment "All resolutions supported." +:model "HL-L258DW" +:interface "WiFi" +:status :good +:comment "All resolutions supported." + :mfg "Canon" :url "https://www.canon-europe.com/support/" +:model "PIXMA MG5765" +:interface "WiFi" +:status :good +:comment "All resolutions supported." + :model "PIXMA G7050" :interface "Ethernet WiFi" :status :untested @@ -36,6 +46,11 @@ :status :good :comment "All resolutions supported." +:model "PIXMA TS5351" +:interface "WiFi" +:status :good +:comment "All resolutions supported." + :model "PIXMA TS6150" :interface "Wifi" :status :untested @@ -82,11 +97,36 @@ :mfg "HP" :url "https://support.hp.com/us-en/drivers/printers" +:model "DeskJet 2710" +:interface "WiFi" +:status :good +:comment "All resolutions supported" + +:model "DeskJet 2723" +:interface "WiFi" +:status :good +:comment "All resolutions supported." + +:model "DeskJet 3760" +:interface "WiFi" +:status :good +:comment "All resolutions supported." + :model "LaserJet MFP M28w" :interface "WiFi" :status :untested :comment "Testers needed!" +:model "LaserJet FlowMFP M578" +:interface "WiFi" +:status :basic +:comment "Issues with duplex ADF" + +:model "LaserJet MFP M630" +:interface "WiFi" +:status :basic +:comment "Issues with duplex ADF" + :model "OfficeJet 4630" :interface "WiFi" :status :untested diff --git a/doc/descriptions/genesys.desc b/doc/descriptions/genesys.desc index e809d4b..33fe735 100644 --- a/doc/descriptions/genesys.desc +++ b/doc/descriptions/genesys.desc @@ -232,8 +232,8 @@ :model "CanoScan 4400F" :interface "USB" :usbid "0x04a9" "0x2228" -:status :complete -:comment "300, 600, 1200 dpi resolutions are supported in flatbed mode; 1200, 2400, 4800 dpi resolutions are supported in transparency scanning mode" +:status :untested +:comment "Physical damage due to overheating reported. Enable in genesys.conf at your own risk. See https://gitlab.com/sane-project/backends/-/issues/436. 300, 600, 1200 dpi resolutions are supported in flatbed mode; 1200, 2400, 4800 dpi resolutions are supported in transparency scanning mode" :model "CanoScan 5600F" :interface "USB" diff --git a/doc/descriptions/gt68xx.desc b/doc/descriptions/gt68xx.desc index f101cd1..b911e98 100644 --- a/doc/descriptions/gt68xx.desc +++ b/doc/descriptions/gt68xx.desc @@ -473,6 +473,6 @@ :interface "USB" :usbid "0x04a7" "0x0444" :status :good -:comment "Works upto 1200 dpi and 12 bits/color." +:comment "Works up to 1200 dpi and 12 bits/color." ; ----------------------------------------------------------------------------- diff --git a/doc/descriptions/hp.desc b/doc/descriptions/hp.desc index 8cf94af..2a7c46b 100644 --- a/doc/descriptions/hp.desc +++ b/doc/descriptions/hp.desc @@ -21,7 +21,7 @@ :url "http://www.hp.com/" :model "ScanJet Plus" ; name models for above-specified mfg. -:interface "Propietary" +:interface "Proprietary" :status :complete :comment "Driver for HP parallel interface card required" diff --git a/doc/descriptions/ma1509.desc b/doc/descriptions/ma1509.desc index 99456b2..2309e41 100644 --- a/doc/descriptions/ma1509.desc +++ b/doc/descriptions/ma1509.desc @@ -26,7 +26,7 @@ :interface "USB" :usbid "0x055f" "0x0010" :status :good -:comment "Works upto 600 dpi. No support for TA and ADF yet." +:comment "Works up to 600 dpi. No support for TA and ADF yet." :mfg "Fujitsu" ; name a manufacturer :url "http://www.fujitsu.com/" diff --git a/doc/descriptions/niash.desc b/doc/descriptions/niash.desc index e4b66d9..b85dc10 100644 --- a/doc/descriptions/niash.desc +++ b/doc/descriptions/niash.desc @@ -1,4 +1,3 @@ -; $Id$ ; SANE Backend specification file ; ; It's basically emacs-lisp --- so ";" indicates comment to end of line. diff --git a/doc/descriptions/pixma.desc b/doc/descriptions/pixma.desc index 3b7ac6c..933780f 100644 --- a/doc/descriptions/pixma.desc +++ b/doc/descriptions/pixma.desc @@ -11,9 +11,9 @@ ; See doc/descriptions.txt for details. :backend "pixma" ; name of backend -:version "0.28.5" ; version of backend (or "unmaintained") +:version "0.28.6" ; version of backend (or "unmaintained") :manpage "sane-pixma" ; name of manpage (if it exists) -;:comment "Devices marked as experimantal are disabled by default. See the manual page for how to enable them." +;:comment "Devices marked as experimental are disabled by default. See the manual page for how to enable them." :devicetype :scanner ; start of a list of devices.... ; other types: :stillcam, :vidcam, @@ -94,6 +94,12 @@ :status :untested :comment "Testers needed!" +:model "PIXMA E3400 Series" +:interface "USB" +:usbid "0x04a9" "0x18b8" +:status :untested +:comment "Testers needed!" + :model "PIXMA E4200 Series" :interface "USB WiFi" :usbid "0x04a9" "0x1855" @@ -112,6 +118,18 @@ :status :complete :comment "All resolutions supported (up to 600DPI)." +:model "PIXMA G2020" +:interface "USB" +:usbid "0x04a9" "0x18bd" +:status :untested +:comment "Testers needed!" + +:model "PIXMA G2060" +:interface "USB" +:usbid "0x04a9" "0x18c1" +:status :untested +:comment "Testers needed!" + :model "PIXMA G2100" :interface "USB" :usbid "0x04a9" "0x1795" @@ -130,6 +148,18 @@ :status :untested :comment "Testers needed!" +:model "PIXMA G3020" +:interface "USB" +:usbid "0x04a9" "0x18bf" +:status :untested +:comment "Testers needed!" + +:model "PIXMA G3060" +:interface "USB" +:usbid "0x04a9" "0x18c3" +:status :untested +:comment "Testers needed!" + :model "PIXMA G4000 Series" :interface "USB WiFi" :usbid "0x04a9" "0x181d" @@ -160,12 +190,24 @@ :status :untested :comment "Testers needed!" +:model "PIXMA G7080" +:interface "USB" +:usbid "0x04a9" "0x1864" +:status :untested +:comment "Testers needed!" + :model "PIXMA GM4000 Series" :interface "USB Ethernet WiFi" :usbid "0x04a9" "0x1869" :status :untested :comment "Testers needed!" +:model "PIXMA GM4080" +:interface "USB" +:usbid "0x04a9" "0x186a" +:status :untested +:comment "Testers needed!" + :model "PIXMA MG2100 Series" :interface "USB" :usbid "0x04a9" "0x1751" @@ -869,6 +911,13 @@ :status :complete :comment "Flatbed and ADF scan. All resolutions supported (up to 600DPI)" + +:model "PIXMA TR7000 Series" +:interface "USB" +:usbid "0x04a9" "0x18b9" +:status :untested +:comment "Testers needed!" + :model "PIXMA TR7500 Series" :interface "USB WiFi" :usbid "0x04a9" "0x1824" @@ -881,6 +930,12 @@ :status :untested :comment "Testers needed!" +:model "PIXMA TR7600 Series" +:interface "USB" +:usbid "0x04a9" "0x18aa" +:status :untested +:comment "Testers needed!" + :model "PIXMA TR8500 Series" :interface "USB Ethernet WiFi" :usbid "0x04a9" "0x1823" @@ -899,6 +954,18 @@ :status :untested :comment "Testers needed!" +:model "PIXMA TR8600 Series" +:interface "USB" +:usbid "0x04a9" "0x18ad" +:status :untested +:comment "Testers needed!" + +:model "PIXMA TR8630 Series" +:interface "USB" +:usbid "0x04a9" "0x18af" +:status :untested +:comment "Testers needed!" + :model "PIXMA TR9530 Series" :interface "USB WiFi" :usbid "0x04a9" "0x185e" @@ -917,6 +984,12 @@ :status :good :comment "All resolutions supported (up to 1200DPI). WiFi not working." +:model "PIXMA TS3400 Series" +:interface "USB" +:usbid "0x04a9" "0x18b7" +:status :untested +:comment "Testers needed!" + :model "PIXMA TS5000 Series" :interface "USB WiFi" :usbid "0x04a9" "0x1802" @@ -1001,18 +1074,42 @@ :status :untested :comment "Testers needed!" +:model "PIXMA TS6400 Series" +:interface "USB" +:usbid "0x04a9" "0x18d3" +:status :untested +:comment "Testers needed!" + :model "PIXMA TS7330 Series" :interface "USB WiFi" :usbid "0x04a9" "0x188f" :status :untested :comment "Testers needed!" +:model "PIXMA TS7400 Series" +:interface "USB" +:usbid "0x04a9" "0x18d7" +:status :untested +:comment "Testers needed!" + +:model "PIXMA TS7430 Series" +:interface "USB" +:usbid "0x04a9" "0x18b2" +:status :untested +:comment "Testers needed!" + :model "PIXMA TS8000 Series" :interface "USB WiFi" :usbid "0x04a9" "0x1800" :status :good :comment "All resolutions supported (up to 2400DPI). WiFi not working." +:model "PIXMA TS8430 Series" +:interface "USB" +:usbid "0x04a9" "0x18b5" +:status :untested +:comment "Testers needed!" + :model "PIXMA TS8100 Series" :interface "USB WiFi" :usbid "0x04a9" "0x1821" diff --git a/doc/descriptions/snapscan.desc b/doc/descriptions/snapscan.desc index 2943e2d..33d7ec3 100644 --- a/doc/descriptions/snapscan.desc +++ b/doc/descriptions/snapscan.desc @@ -1,5 +1,3 @@ -; $Id$ -; ; SANE Backend specification file (Matto Marjanovic's format) ; ; It's basically emacs-lisp --- so ";" indicates comment to end of line. diff --git a/doc/descriptions/unsupported.desc b/doc/descriptions/unsupported.desc index 03788c4..e7c1954 100644 --- a/doc/descriptions/unsupported.desc +++ b/doc/descriptions/unsupported.desc @@ -402,20 +402,6 @@ :status :unsupported :comment "GL841 based, to be added to genesys backend" -:model "CanoScan LiDE 600" -:interface "USB" -:url "http://www.juergen-ernst.de/info_sane.html" -:usbid "0x04a9" "0x2224" -:status :unsupported -:comment "Philips chip. Backend started, see link" - -:model "CanoScan LiDE 600F" -:interface "USB" -:url "http://www.juergen-ernst.de/info_sane.html" -:usbid "0x04a9" "0x2224" -:status :unsupported -:comment "Philips chip. Backend started, see link" - :model "FS4000" :url "unsupported/canon-fs4000.html" :interface "USB SCSI" @@ -709,7 +695,7 @@ :interface "USB" :usbid "0x06dc" "0x0012" :status :unsupported -:comment "Unsuported. See link for details." +:comment "Unsupported. See link for details." :model "ColorPage HR8" :url "unsupported/genius-colorpage-hr8.html" @@ -2255,7 +2241,7 @@ :interface "Parport" :status :unsupported :url "http://www.autistici.org/tamarhack/" -:comment "Unsupported at the moment. See link for a project for that scanner taht may support it in future." +:comment "Unsupported at the moment. See link for a project for that scanner that may support it in future." :model "Artiscan 9600 pro 36" ; name models for above-specified mfg. :interface "Parport" diff --git a/doc/gamma4scanimage.man b/doc/gamma4scanimage.man index 576d148..203c61e 100644 --- a/doc/gamma4scanimage.man +++ b/doc/gamma4scanimage.man @@ -26,41 +26,57 @@ and maximum output value of the gamma table. .PP .BR gamma -is a floating point value, neutral value is 1.0, if the value is larger than -1.0 then the image gets brighter. +is a floating point value, neutral value being 1.0. If the value is larger than +1.0 then the image is brighter. .PP .BR shadow defines the minimum input value that is necessary to create an output value -larger than zero. shadow has to be in the range [0..maxin]. Its default value -is 0. +larger than zero. shadow has to be in the range +.RB "[0.." "maxin" "]." +Its default value is 0. .PP .BR highlight defines the maximum input value that produces an output value smaller than -maxout. highlight has to be in the range [0..maxin], highlight has to be -larger than shadow. Its default value is the same as maxin (16383 if not set). +maxout. highlight must be in the range +.RB "[0.." "maxin" "]" +and +larger than shadow. Its default value is the same as +.B maxin +(16383 if not set). .PP -.BR maxin +.B maxin defines the size of the gamma table. The size depends on the scanner/backend. -If the scanner uses 8 bits gamma input then maxin has to be set to 255, for 10 -bits 1023, for 12 bits 4095, for 14 bits 16383. The default is 16383. To find -out what value maxin has to be call scanimage with a very large gamma table -[0]0-[99999]255 then scanimage prints an error message with the needed size of -the gamma table. +If the scanner uses 8 bit gamma input then +.B maxin +must be set to 255, 1023 for 10 +bits, 4095 for 12 bits, and 16383 for 14 bits. The default is 16383. To find +out what value +.B maxin +has to be, call +.BR scanimage (1) +with a very large gamma table +[0]0-[99999]255 and +.BR scanimage (1) +will print an error message with the needed gamma table size. .PP -.BR maxout -defines the maximum output value. Take a look at the output of scanimage \-h to -find out what maxout has to be. The default value is 255. +.B maxout +defines the maximum output value. Take a look at the output of +.I scanimage \-h +to find out what +.B maxout +must be. The default value is 255. .PP .SH EXAMPLE -.B scanimage \-\-custom\-gamma=yes \-\-gamma\-table -.I `gamma4scanimage 1.8 0 11500 16383 255` +scanimage \-\-custom\-gamma=yes \-\-gamma\-table +`gamma4scanimage 1.8 0 11500 16383 255` >image.pnm .SH SEE ALSO +.BR sane (7), .BR scanimage (1) .SH AUTHOR Oliver Rauch .SH EMAIL-CONTACT -Oliver.Rauch@Rauch-Domain.DE +.I Oliver.Rauch@Rauch-Domain.DE diff --git a/doc/gt68xx/gt68xx.CHANGES b/doc/gt68xx/gt68xx.CHANGES index aa87504..074c1c9 100644 --- a/doc/gt68xx/gt68xx.CHANGES +++ b/doc/gt68xx/gt68xx.CHANGES @@ -80,7 +80,7 @@ V 1.0.73 (2005-08-19) V 1.0.72 (2005-08-18) * Finally fixed the problem concerning scanning on *BSD. Scanning only worked - once. After that, the scanner wasn't even detected anymore beacuse the config + once. After that, the scanner wasn't even detected anymore because the config descriptor returned by the device was corrupted. This is a hardware bug. When filling the internal memory of the scanner completely, the config descriptor is overwritten. The work-around is to ask the scanner for the device @@ -205,7 +205,7 @@ V 1.0-61 (2004-06-18) * Check for status of read_scanned_data every 10 ms. Avoids short stops before scan data comes in. * Added resolution limit for using backtracking. - * Reduced deafult CCD backtracking to 0x10 lines. + * Reduced default CCD backtracking to 0x10 lines. * CCD coarse calibration: * Check if calib has succeeded per color now (fewer loops). * Added loop detection now. @@ -399,7 +399,7 @@ V 1.0-40 (2003-02-22) - Added indormation about Medion 4394. - Mention ma1509 backend. - Fix segfault when calling sane_open with an empty device name. -- Explicitely initialize global variables to avoid segfaults when calling +- Explicitly initialize global variables to avoid segfaults when calling sane_init/sane_exit more than once. V 1.0-39 (2003-02-16) @@ -416,7 +416,7 @@ V 1.0-38 (2003-02-05) - Increase the lowest black for CCD coarse calibration to avoid too much black. - Adjusted internal gamma correction to avoid getting 0 for high gamma values. - CCD scanners use color mode for coarse+quality cal now. This fixes the - problem with extremly high gains and terrible quality cal in gray mode at + problem with extremely high gains and terrible quality cal in gray mode at least for the BearPaw 1200 TA. --> Thanks to Alexei V. Mezin for reporting these bugs. - Preview isn't always in 8 bit mode now (can be selected by option). @@ -533,8 +533,8 @@ V 1.0-26 (2002-10-22) - Several fixes for Medion MD-9385 and Artec Ultima 2000 based scanners. The Cytron MD 9385 works now. -- Diabled Plustek-like firmware check again, didn't work for MD 9385. -- Splitted flags for mirror_x and sset_home. +- Disabled Plustek-like firmware check again, didn't work for MD 9385. +- Split flags for mirror_x and sset_home. V 1.0-25 (2002-10-20) @@ -575,7 +575,7 @@ V 1.0-22 (2002-10-07), - Line calibration uses the bit depth of the main scan now. - Vendor, product ids and other information is printed when debugging is active - Fixed segfault in attach (). -- Fixed endianess issues (untested). +- Fixed endianness issues (untested). - Code cleanup. V 1.0-21 (2002-10-07), @@ -612,7 +612,7 @@ V 1.0-18 (2002-10-01) - Added detection of Artec Ultima 2000. - Updated Lexmark X70 settings. -- Fixed segfault that occured when no device was detected. +- Fixed segfault that occurred when no device was detected. - Changed test for loaded firmware for GT-6801 scanners. V 1.0-17 (2002-10-01) @@ -699,7 +699,7 @@ V 1.0-9 (2002-09-17) - Added option to disable automatic gain (->less ugly colors for GT-6801 based models) -- Fixed segfault that occured when a scan was cancelled +- Fixed segfault that occurred when a scan was cancelled - Preview uses slow but safe (?) 300 dpi 8 bit modes now - Fixed bug concerning X0/Y0 coordinates - Started implementing dpeth option (doesn't work yet) diff --git a/doc/gt68xx/gt68xx.TODO b/doc/gt68xx/gt68xx.TODO index 74aeb17..4909b08 100644 --- a/doc/gt68xx/gt68xx.TODO +++ b/doc/gt68xx/gt68xx.TODO @@ -33,7 +33,7 @@ Mustek BearPaw 2448 TA Plus: - Sometimes there is a USB protocol error when cancelling the scan? - top borders move with resolution (happened in the early days with 2400 TA!) - gray scans have different brightness -- scan motor is bumpy and freezes sometimes, looks like accelaration is too big +- scan motor is bumpy and freezes sometimes, looks like acceleration is too big (firmware problem?) - vertical stripes - TA settings are wrong @@ -93,7 +93,7 @@ Mustek ScanExpress 1248 UB ok Plustek OpticSlim 2400 -- only upto 1200 dpi vertical works +- only up to 1200 dpi vertical works - only 8 and 12 bit work, 16 doesn't (check Windows) - exposure is extremely high and seems to have similar problems as with other CIS scanners (reaches limit also) @@ -102,4 +102,4 @@ Mustek ScanExpress 2400 USB - make it work (nobody seems to have this device) Visioneer OneTouch 7300 -- 16 bit doesn't seem to work despite beeing advertized +- 16 bit doesn't seem to work despite being advertized diff --git a/doc/mustek/mustek.CHANGES b/doc/mustek/mustek.CHANGES index c5de63c..99d85d4 100644 --- a/doc/mustek/mustek.CHANGES +++ b/doc/mustek/mustek.CHANGES @@ -116,7 +116,7 @@ CHANGES for the SANE Mustek backend * Used my own address instead of sane-devel for bug reports. 2002-05-31 - * Explicitely set some arrays to 0. + * Explicitly set some arrays to 0. 2002-05-28 * Released Mustek backend 1.0-124. @@ -250,7 +250,7 @@ CHANGES for the SANE Mustek backend * Released Mustek backend 1.0-110. 2001-07-10 - * Added debug output for the total amount of data transfered to the + * Added debug output for the total amount of data transferred to the frontend. * Fixed bug in fix_line_distance_block which lead to too much data transferred to sane_read. @@ -338,7 +338,7 @@ CHANGES for the SANE Mustek backend * Added 36 bit color mode for the Paragon Pro scanners. 2000-12-31 - * Added function little_endian (from coolscan.c) to check the endianess of + * Added function little_endian (from coolscan.c) to check the endianness of the current architecture (needed for 16 bit frames). * Added option for Gray fast * Added option for bit depth (8 and 12 bits for the Pro models) @@ -442,7 +442,7 @@ CHANGES for the SANE Mustek backend * Added support for TAIV for SE 12000 SP. Lamp is turned off while scanning (seems to work for firmware >= 2.00) * Adjusted transparency adapter support for all ScanExpress scanners. - The 12000 A3 SP can only do A4 beacuse I don't have the right TA. + The 12000 A3 SP can only do A4 because I don't have the right TA. * don't use u_int* types in mustek.h because the definitions for these types are not included @@ -660,7 +660,7 @@ CHANGES for the SANE Mustek backend * Released backend version 1.0-91 2000-07-18 - * Removed again MUSTEK_FLAG_LD_NONE for MFS-08000SP. Maybe the automatical + * Removed again MUSTEK_FLAG_LD_NONE for MFS-08000SP. Maybe the automatic detection works now. 2000-07-15 @@ -709,7 +709,7 @@ CHANGES for the SANE Mustek backend * fixed debug output bug in fix_linedistance_se (found by Jan-Erik Karlsson) 2000-06-21 - * fixed dependancy of mustek.h on sane-backends.h + * fixed dependency of mustek.h on sane-backends.h 2000-06-19 * Fixed gamma correction in lineart mode for Paragon 1200 A3 @@ -733,7 +733,7 @@ CHANGES for the SANE Mustek backend 24 bit per pixel are supported (12/36 are possible in hardware) 2000-06-16 - * addded debugging output in sane_control_option + * added debugging output in sane_control_option * added gamma correction for Paragon 1200 A3 Pro (doesn't work correctly yet) 2000-06-15 @@ -789,7 +789,7 @@ CHANGES for the SANE Mustek backend 2000-05-21 * The Mustek Paragon 1200 A3 PRO is now detected. This is only a test - release. Be carefull and read the PROBLEMS file if you want to + release. Be careful and read the PROBLEMS file if you want to try this scanner. 2000-05-19 @@ -801,7 +801,7 @@ CHANGES for the SANE Mustek backend 2000-05-12 * fixed bug in distinguishing firmware formats - * added shrinked image fix to ScanExpress 12000SP models <= v2.0 + * added shrunk image fix to ScanExpress 12000SP models <= v2.0 2000-05-08 * fixed remaining sane_cancel problems (in non_blocking mode) @@ -981,7 +981,7 @@ CHANGES for the SANE Mustek backend * probably fixed linedistance correction at high resolutions for MFS-1200SP firmware 1.00 and possibly others (patch from Andreas Beck) * added check for ADF ready in sane_start (patch from Joerg Anders) - * Bug fix in the STORE makros (patch from Norbert Mueller) + * Bug fix in the STORE macros (patch from Norbert Mueller) 2000-03-06 diff --git a/doc/mustek_usb/mustek_usb.CHANGES b/doc/mustek_usb/mustek_usb.CHANGES index b31f248..f1a8895 100644 --- a/doc/mustek_usb/mustek_usb.CHANGES +++ b/doc/mustek_usb/mustek_usb.CHANGES @@ -7,7 +7,7 @@ CHANGES for the SANE Mustek USB backend * Added workaround for data0 toggle bug. I think this is a bug in the chipset. The chipset doesn't set the toggle to data0 when the endpoints are reset. As this is done whenever the device files/libusb is closed, - this backend worked ony once. Now we count the number of URBs and + this backend worked only once. Now we count the number of URBs and just read/write some crap if the number is odd. 2003-09-21 @@ -20,7 +20,7 @@ CHANGES for the SANE Mustek USB backend * Release of version 1.0-16. 2003-02-22: - * Iniatialize global variables explicitely. + * Iniatialize global variables explicitly. * Mention ma1509. 2002-11-20: @@ -78,7 +78,7 @@ CHANGES for the SANE Mustek USB backend 2002-03-16: * mustek_usb.c: Fixed segfault when opening device again after closing. * mustek_usb.c: Fixed possible segfault when name="". - * mustek_usb.c: Type for option 0 must be set to SANE_TYPE_INT explicitely. + * mustek_usb.c: Type for option 0 must be set to SANE_TYPE_INT explicitly. 2002-02-14: * Fixed some problems with wrong formats in DBG statements. @@ -126,7 +126,7 @@ CHANGES for the SANE Mustek USB backend 2001-11-14 * Added 600 USB detection. No support at all yet. - * Removed unneccessary calls to usb_low_open and usb_low_close. This + * Removed unnecessary calls to usb_low_open and usb_low_close. This fixed the FreeBSD problems. * Updated all SANE comments ("1200UB and similar"). @@ -161,7 +161,7 @@ CHANGES for the SANE Mustek USB backend 2001-09-13 * Added check for negative width and height. - * Changed status to NEW (internaly: beta). + * Changed status to NEW (internally: beta). * Added check for too high gamma values (xscanimage is buggy). * Return SANE_STATUS_CANCELLED in sane_read if scan was cancelled. * Updated manual page. @@ -289,7 +289,7 @@ CHANGES for the SANE Mustek USB backend * Check vendor/product directly after sane_open. 2001-08-06 - * Added scan buffer. It's used if the buffer suplied with sane_read is + * Added scan buffer. It's used if the buffer supplied with sane_read is smaller than one scan line. 2001-08-06 diff --git a/doc/mustek_usb2/mustek_usb2.CHANGES b/doc/mustek_usb2/mustek_usb2.CHANGES index 6e37236..714d461 100644 --- a/doc/mustek_usb2/mustek_usb2.CHANGES +++ b/doc/mustek_usb2/mustek_usb2.CHANGES @@ -10,7 +10,7 @@ V 1.0-9 (2005-10-02) - Removed global variables in mustek_usb2.c: Deleted the following variables (not necessary): m_bIsOpen - Moved the following varaiables to Mustek_Scanner structure: + Moved the following variables to Mustek_Scanner structure: m_bIsScanning m_bIsReading setpara @@ -104,7 +104,7 @@ V 1.0-4 (2005-09-27) - Changed backend name to mustek_usb2. - Used dos2unix to change dos line endings to unix. - Added mustek_usb2.TODO. -- Changed several occurences of "//" to "/* */". +- Changed several occurrences of "//" to "/* */". - Used DBG instead of XDBG. - Defined DBG levels in mustek_usb2_asic_low.h. - Changed code to use sanei_usb instead of home-grown usb functions. diff --git a/doc/plustek/FAQ b/doc/plustek/FAQ index a3a224f..92a4e72 100644 --- a/doc/plustek/FAQ +++ b/doc/plustek/FAQ @@ -111,7 +111,7 @@ SOLUTION: --------- Simply load the parport module. You can add this dependency to your /etc/modules.conf (or /etc/conf.modules) file (see INSTALL). -Then everytime you load pt_drv with modprobe, parport will be loaded +Then every time you load pt_drv with modprobe, parport will be loaded automatically. After modifying this file, call depmod -va @@ -339,7 +339,7 @@ A: I recommend to uninstall the previous one. rpm -e sane-1.0.1-94 - After theses steps, sane should be removed. + After these steps, sane should be removed. I'm not sure, but you might have to remove the /etc/sane.d manually... Now got to your sane-1.0.3 stuff and reinstall this as described. Before using, you might have a look diff --git a/doc/plustek/Plustek-PARPORT.changes b/doc/plustek/Plustek-PARPORT.changes index 6aa878b..43131f7 100644 --- a/doc/plustek/Plustek-PARPORT.changes +++ b/doc/plustek/Plustek-PARPORT.changes @@ -97,7 +97,7 @@ Version 0.39 08/11/2001 3.0 Added forceMode switch 4.0 Fixed a problem in the PT12 code that causes I/O timeouts 5.0 Added Genius Colorpage Vivivd III V2 stuff - 6.0 Added A3I stuff aquired from Plustek + 6.0 Added A3I stuff acquired from Plustek 7.0 Fixed a bug, that causes some seg-faults Version 0.40 12/17/2001 @@ -110,7 +110,7 @@ Version 0.41 01/10/2002 1.0 Changed IOCTL interface to the kernel module to allow adjustment of some driver internal variables 2.0 Changed plustek.conf configuration fileformat to reflect the enhanced - capabilites + capabilities Version 0.42 02/12/2002 1.0 Added custom gamma table support diff --git a/doc/plustek/Plustek-USB.txt b/doc/plustek/Plustek-USB.txt index 939d4d7..29989d0 100644 --- a/doc/plustek/Plustek-USB.txt +++ b/doc/plustek/Plustek-USB.txt @@ -195,7 +195,7 @@ When using libusb with SANE, then you should also use the hotplug utilities to automatically setup your device nodes (at least the permissions) and prevent scanner.o from loading. -Assuming, that these utilites are properly installed on your box, you have +Assuming, that these utilities are properly installed on your box, you have to tweak and add some files. In directory (where of course the config files reside): @@ -292,7 +292,7 @@ it. If you have carried out all of the above steps, then sane-find-scanner should be able to recognise your scanner correctly. -sane-find-scanner probes all of the devices on the SCSI and USB busses, and +sane-find-scanner probes all of the devices on the SCSI and USB buses, and so you may find that it outputs "unable to get minor data" errors or similar to your terminal, or to your error logs, you can safely ignore these as long as it does that, and has recognised your scanner. @@ -339,7 +339,7 @@ log, as well as (where possible) the output of the scanimage command (if you can't capture it directly, an as-accurate-as-possible description is MUCH better than nothing!), and try and get all of the activity that your scanner did as well (light -came on? didnt? motors came on? etc?) and email that to the plustek list +came on? didn't? motors came on? etc?) and email that to the plustek list (<plustek@linuxhacker.org>). For the particularly adventurous only... diff --git a/doc/sane-abaton.man b/doc/sane-abaton.man index f1f33cb..13c3c6b 100644 --- a/doc/sane-abaton.man +++ b/doc/sane-abaton.man @@ -16,7 +16,8 @@ works with this backend, or if you own an Abaton scanner that does not work with this backend, please contact .IR sane\-devel@alioth-lists.debian.net with the model number, so that arrangements can be made to include -support for it. Have a look at http://www.sane\-project.org/mailing\-lists.html +support for it. Have a look at +.I http://www.sane\-project.org/mailing\-lists.html concerning subscription to sane\-devel. .PP Abaton is out of business, and these scanners are not supported by @@ -48,13 +49,17 @@ name takes a format such as .I /dev/sga or .IR /dev/sg0 , -for example. See sane\-scsi(5) for details. +for example. See +.BR sane\-scsi (5) +for details. + .SH CONFIGURATION The contents of the .I abaton.conf file is a list of device names that correspond to Abaton scanners. Empty lines and lines starting with a hash mark (#) are ignored. See -sane\-scsi(5) on details of what constitutes a valid device name. +.BR sane\-scsi (5) +on details of what constitutes a valid device name. .SH FILES .TP @@ -77,13 +82,18 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the -environment variable ends with the directory separator character, then -the default directories are searched after the explicitly specified -directories. For example, setting +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator +character, then the default directories are searched after the explicitly +specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_ABATON If the library was compiled with debug support enabled, this @@ -119,8 +129,14 @@ confidence that it will work, as well as to fully exploit the information returned by the INQUIRY command. .SH "SEE ALSO" -sane(7), sane\-scsi(5), scanimage(1) +.BR sane (7), +.BR sane\-scsi (5), +.BR scanimage (1) .SH AUTHOR -The sane\-abaton backend was partially written by David Huggins-Daines, -based on the sane\-apple backend by Milon Firikis. +The +.B sane\-abaton +backend was partially written by David Huggins-Daines, +based on the +.BR sane\-apple (5) +backend by Milon Firikis. diff --git a/doc/sane-agfafocus.man b/doc/sane-agfafocus.man index 34ec463..53b2d37 100644 --- a/doc/sane-agfafocus.man +++ b/doc/sane-agfafocus.man @@ -32,7 +32,8 @@ If you own a scanner other than the ones listed above that works with this backend, please let us know by sending the scanner's model name, SCSI id, and firmware revision to .IR sane\-devel@alioth-lists.debian.net . -Have a look at http://www.sane\-project.org/mailing\-lists.html +Have a look at +.I http://www.sane\-project.org/mailing\-lists.html concerning subscription to sane\-devel. .PP All of these scanners are pre-SCSI-2, and do not even report properly @@ -55,7 +56,10 @@ a device name could be .I /dev/sga or .IR /dev/sge , -for example. See sane\-scsi(5) for details. +for example. See +.BR sane\-scsi (5) +for details. + .SH CONFIGURATION The contents of the .I agfafocus.conf @@ -93,19 +97,25 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in /etc/sane.d. If the value of the -environment variable ends with the directory separator character, then -the default directories are searched after the explicitly specified -directories. For example, setting +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator +character, then the default directories are searched after the +explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"/etc/sane.d" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_AGFAFOCUS 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. -SANE_DEBUG_AGFAFOCUS values: +.B SANE_DEBUG_AGFAFOCUS +values: .sp .ft CR @@ -138,8 +148,9 @@ these options have been disabled. The scanners that do not support disconnect have problems with SCSI timeouts if the SCSI bus gets loaded, eg. if you do a kernel build at the same time as scanning. To see if your scanner supports -disconnect, run "SANE_DEBUG_AGFAFOCUS=128 scanimage \-L" in sh and look -for the "disconnect:" line) +disconnect, run +.I "SANE_DEBUG_AGFAFOCUS=128 scanimage \-L" +in a terminal and look for the "disconnect:" line. .SH DEBUG If you have problems with SANE not detecting your scanner, make sure the @@ -147,12 +158,14 @@ Artec backend is disabled. Somehow, this backend causes at least my scanner not to respond correctly to SCSI inquiry commands. .PP If you encounter a bug please set the environment variable -SANE_DEBUG_AGFAFOCUS to 128 and try to regenerate the problem. Then -send me a report with the log attached. +.B SANE_DEBUG_AGFAFOCUS +to 128 and try to regenerate the problem. Then send me a report with the +log attached. .PP If you encounter a SCSI bus error or trimmed and/or displaced images please -also set the environment variable SANE_DEBUG_SANEI_SCSI to 128 before sending -me the report. +also set the environment variable +.B SANE_DEBUG_SANEI_SCSI +to 128 before sending me the report. .SH TODO .TP @@ -166,9 +179,10 @@ a scanner, I could be helpful in adding support for these scanners. The AGFA HORIZON scanners are SCSI-2 scanners, and it would probably be easier to support these scanners in a SCSI-2 compliant backend. + .SH SEE ALSO -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5) .SH AUTHOR - Ingo Schneider and Karl Anders \[/O]ygard. diff --git a/doc/sane-apple.man b/doc/sane-apple.man index 3418fd0..0c057fb 100644 --- a/doc/sane-apple.man +++ b/doc/sane-apple.man @@ -24,8 +24,9 @@ If you own a Apple scanner other than the ones listed above that works with this backend, please let us know by sending the scanner's model name, SCSI id, and firmware revision to .IR sane\-devel@alioth-lists.debian.net . -See http://www.sane\-project.org/mailing\-lists.html for details on how to subscribe to -sane\-devel. +See +.I http://www.sane\-project.org/mailing\-lists.html +for details on how to subscribe to sane\-devel. .SH "DEVICE NAMES" This backend expects device names of the form: @@ -43,14 +44,18 @@ symlink to such a device. Under Linux, such a device name could be .I /dev/sga or .IR /dev/sge , -for example. See sane\-scsi(5) for details. +for example. See +.BR sane\-scsi (5) +for details. + .SH CONFIGURATION The .I apple.conf file is a list of options and device names that correspond to Apple scanners. Empty lines and lines starting with a hash mark (#) are -ignored. See sane\-scsi(5) on details of what constitutes a valid -device name. +ignored. See +.BR sane\-scsi (5) +on details of what constitutes a valid device name. .PP Options come in two flavors: global and positional ones. Global options apply to all devices managed by the backend, whereas positional @@ -83,13 +88,18 @@ This environment variable is list of directories where SANE looks for the configuration file. Under UNIX directory names are separated by a colon (`:'), under OS/2 by a semi-colon (`;'). If SANE_CONFIG_DIR is not set, SANE defaults to -searching the current working directory (".") and then /etc/sane.d. +searching the current working directory (".") and then +.IR @CONFIGDIR@ . If the value of $SANE_CONFIG_DIR ends with the separator character, the default directories are searched after the directory list. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in that order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in that order). .TP .B SANE_DEBUG_APPLE Controls the debug level. A value of 255 prints @@ -100,7 +110,7 @@ library compiled with debug support. The apple backend is now in version 0.3 (Tue Jul 21 1998). Since I only have the AppleScanner and not the other models (OneScanner, ColorOneScanner) I can only develop/test for the AppleScanner effectively. -However with this release I almost completed the gui part of all scanners. +However with this release I almost completed the GUI part of all scanners. Most of the functionality is there. At least OneScanner should scan at the AppleScanner's compatible modes (LineArt, HalfTone, Gray16). My personal belief is that with a slight touch of debugging the OneScanner @@ -167,7 +177,7 @@ 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 -.B ftp://ftpdev.info.apple.com/devworld/Technical_Documentation/Peripherals_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. @@ -212,7 +222,8 @@ hardware, or may be bugs in your driver or in SANE itself... .SH DEBUG If you encounter a GUI bug please set the environmental variable -SANE_DEBUG_APPLE to 255 and rerun the exact sequence of keystrokes +.B SANE_DEBUG_APPLE +to 255 and rerun the exact sequence of keystrokes and menu selections to reproduce it. Then send me a report with the log attached. .PP @@ -223,9 +234,16 @@ would be very helpful. If you want to offer some help but you don't have a scanner, or you don't have the model you would like to help with, or you are a SANE developer and you just want to take a look at how the apple backend -looks like, goto to apple.h and #define the NEUTRALIZE_BACKEND +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. Available options are APPLESCANNER, ONESCANNER, COLORONESCANNER. +macro. Available options are +.BR APPLESCANNER , +.BR ONESCANNER , +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 @@ -234,10 +252,12 @@ the report. .SH TODO .TP .B Non Blocking Support -Make sane\-apple a non blocking backend. Properly support -.B sane_set_io_mode +Make +.B sane\-apple +a non blocking backend. Properly support +.BR sane_set_io_mode () and -.B sane_get_select_fd +.BR sane_get_select_fd () .TP .B Scan Make scanning possible for all models in all supported modes. @@ -245,9 +265,13 @@ Make scanning possible for all models in all supported modes. Add other missing functionality .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5) .SH AUTHOR -The sane\-apple backend was written not entirely from scratch by -Milon Firikis. It is mostly based on the mustek backend from -David Mosberger and Andreas Czechanowski +The +.B sane\-apple +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 diff --git a/doc/sane-artec.man b/doc/sane-artec.man index 9dd4f44..a738660 100644 --- a/doc/sane-artec.man +++ b/doc/sane-artec.man @@ -32,14 +32,7 @@ the following scanners are known to work at least partially with this backend: Although this manual page is generally updated with each release, up-to-date information on new releases and extraneous helpful hints are available from the backend homepage: -.br -.br -.RS -.B http://www4.infi.net/~cpinkham/sane/ -.RE - -.SH DOCUMENTATION - +.IR http://www4.infi.net/~cpinkham/sane . .SH CONFIGURATION @@ -48,12 +41,11 @@ The contents of the file are a list of device names that correspond to Artec scanners. Empty lines and lines starting with a hash mark (#) are ignored. See -.I sane\-scsi(5) +.BR sane\-scsi (5) on details of what constitutes a valid device name. Sample file: .br -.br .nf # artec.conf # @@ -107,6 +99,7 @@ The static library implementing this backend. .I @LIBDIR@/libsane\-artec.so The shared library implementing this backend (present on systems that support dynamic loading). + .SH ENVIRONMENT .TP .B SANE_CONFIG_DIR @@ -115,19 +108,26 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi- colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working direc- -tory (".") and then in @CONFIGDIR@. If the value of the +tory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_ARTEC 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: -SANE_DEBUG_ARTEC values +.B SANE_DEBUG_ARTEC +values: .ft CR .nf @@ -170,9 +170,10 @@ the SCSI bus (and/or machine) by not having patience enough when scanning. correction is not totally working on models other than the AT3. .SH "SEE ALSO" - -sane(7), sane\-scsi(5) +.BR sane (7) , +.BR sane\-scsi (5) .SH AUTHOR -Chris Pinkham (cpinkham@corp.infi.net) +Chris Pinkham +.I <cpinkham@corp.infi.net> diff --git a/doc/sane-artec_eplus48u.man b/doc/sane-artec_eplus48u.man index 7e7ec37..70f4254 100644 --- a/doc/sane-artec_eplus48u.man +++ b/doc/sane-artec_eplus48u.man @@ -17,14 +17,19 @@ the scan area. .PP If you own a scanner other than the ones mentioned on the list that works with this backend, please let us know this by sending the scanner's exact model name and -the USB vendor and product ids (e.g. from /proc/bus/usb/devices, -sane\-find\-scanner or syslog) to me. Even if the scanner's name is only +the USB vendor and product ids (e.g. from +.IR /proc/bus/usb/devices , +.BR sane\-find\-scanner (1) +or syslog) to me. Even if the scanner's name is only slightly different from the models mentioned above, please let me know. .PP .SH KERNEL ISSUES If libusb-0.1.6 or later is installed, this section can be skipped. The -scanner should be found by sane\-find\-scanner without further actions. For -setting permissions and general USB information look at sane\-usb(5). +scanner should be found by +.BR sane\-find\-scanner (1) +without further actions. For setting permissions and general USB information +look at +.BR sane\-usb (5). .PP When you are using the scanner module, a Linux kernel 2.4.12 or newer is required. @@ -32,11 +37,16 @@ required. .SH FIRMWARE FILE You need a firmware file for your scanner. That's a small file containing software that will be uploaded to the scanner's memory. For the scanners -mentioned above, it's usually named Artec48.usb or 1200.usb. You can find it on -the installation CD that was provided by the manufacturer, normally in the -directory Win98, WinMe or similar. If the Windows-driver is installed on your -computer, then you can also find the firmware file under -c:\\windows\\system32\\drivers. +mentioned above, it's usually named +.I Artec48.usb +or +.IR 1200.usb . +You can find it on the installation CD that was provided by the manufacturer, +normally in the directory Win98, WinMe or similar. +If the Windows-driver is installed on your computer, then you can also +find the firmware file under +.IR c:\\windows\\system32\\drivers . + .SH CONFIGURATION The contents of the .I artec_eplus48u.conf @@ -105,13 +115,18 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in /usr/local/etc/sane.d. If the value of the -environment variable ends with the directory separator character, then -the default directories are searched after the explicitly specified -directories. For example, setting +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory +separator character, then the default directories are searched after +the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"/usr/local/etc/sane.d" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_ARTEC_EPLUS48U If the library was compiled with debug support enabled, this @@ -122,15 +137,19 @@ Example: export SANE_DEBUG_ARTEC_EPLUS48U=3 .SH "SEE ALSO" -sane(7), sane\-usb(5) +.BR sane (7), +.BR sane\-usb (5) .SH AUTHOR -Michael Herder +Michael Herder. .br This backend is based on the gt68xx test-program written by Sergey Vlasov, Andreas Nowack, and David Stevenson. Thanks to everyone who tested the backend or reported bugs. .br -This man page is based on man sane\-gt68xx, written by Henning Meier-Geinitz. +This man page is based on man +.BR sane\-gt68xx (5), +written by Henning Meier-Geinitz. + .SH BUGS This backend has been tested on Linux only. If you are using it on a different platform, please contact us. diff --git a/doc/sane-as6e.man b/doc/sane-as6e.man index 2e7dbf6..22e357c 100644 --- a/doc/sane-as6e.man +++ b/doc/sane-as6e.man @@ -8,26 +8,27 @@ The .B sane\-as6e library implements a SANE (Scanner Access Now Easy) backend that provides access to Artec AS6E flatbed scanner. -.B It requires the as6edriver program in order to operate. -The as6edriver program is -.B not -included with the SANE package. -It can be found at -.BR http://as6edriver.sourceforge.net. +It requires the +.B as6edriver +program in order to operate. The +.B as6edriver +program is not included with the SANE +package. It can be found at +.IR http://as6edriver.sourceforge.net . See the as6edriver documentation for technical information. .PP The -.I as6edriver -program must be in the path for executables ($PATH). Especially if you run -.I saned +.B as6edriver +program must be in the path for executables +.RB ( $PATH ). +Especially if you run +.BR saned (8) (the SANE network scanning daemon), take care to setup the path for -.I inetd +.BR inetd (8) or -.I xinetd +.BR xinetd (8) correctly or place the program in a directory that is in the path. -.PP - .SH FILES .B as6edriver \- driver program that controls the scanner. @@ -36,10 +37,13 @@ correctly or place the program in a directory that is in the path. .BR sane (7), .BR as6edriver (5), .BR saned (8), -.B http://as6edriver.sourceforge.net +.BR inetd (8), +.BR xinetd (8) +.br +.I http://as6edriver.sourceforge.net .SH AUTHOR Eugene S. Weiss .SH EMAIL-CONTACT -yossarian@users.sourceforge.net +.I yossarian@users.sourceforge.net diff --git a/doc/sane-avision.man b/doc/sane-avision.man index f0a5091..517ac1b 100644 --- a/doc/sane-avision.man +++ b/doc/sane-avision.man @@ -5,10 +5,6 @@ sane\-avision \- SANE backend for original Avision and Avision OEM scanners (HP, Minolta, Mitsubishi, UMAX and possibly more) flatbed and film scanners. -.SH ABOUT THIS FILE - -This file is a short description for the avision-backend shipped with SANE. - .SH DESCRIPTION The .B sane\-avision @@ -16,7 +12,7 @@ library implements a SANE (Scanner Access Now Easy) backend that provides access to various Avision scanners and the Avision OEM scanners labelled by HP, Minolta, Mitsubishi or Fujitsu. -It is fully big-endian aware and in every-day use on PowerPC and SPARC +It is fully big-endian aware and in everyday use on PowerPC and SPARC systems. .B I suggest you hold one hand on the power-button of the scanner while @@ -102,9 +98,14 @@ Where .I scsi-spec is the path-name to a special device or a device ID for the device that corresponds to a SCSI scanner. The special device name must be a generic -SCSI device or a symlink to such a device, for example on Linux "/dev/sga" -or "/dev/sg0". The device ID is the ID returned by the scanner, for example -"HP" or "AVISION". See sane\-scsi(5) for details. +SCSI device or a symlink to such a device, for example on Linux +.I /dev/sga +or +.IR /dev/sg0 . +The device ID is the ID returned by the scanner, for example +"HP" or "AVISION". See +.BR sane\-scsi (5) +for details. .TP Note: Since the backend now includes native USB access, @@ -116,10 +117,12 @@ the HP 53xx, HP 74xx or Minolta film-scanners. .I usb-spec is the USB device name, the vendor/product ID pair or the name used by libusb corresponding to the USB scanner. For example "0x03f0 0x0701" or -"libusb:002:003". See sane\-usb(5) for details. +"libusb:002:003". See +.BR sane\-usb (5) +for details. The program -.IR sane\-find\-scanner +.BR sane\-find\-scanner (1) helps to find out the correct scsi or usb device name. A list with supported devices is built into the avision backend so @@ -147,13 +150,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_AVISION If the library was compiled with debug support enabled, this @@ -165,11 +174,14 @@ Example: export SANE_DEBUG_AVISION=7 .SH "SEE ALSO" -sane(7), sane\-scsi(5), sane\-usb(5) +.BR sane (7), +.BR sane\-scsi (5), +.BR sane\-usb (5) .br -http://exactcode.com/site/open_source/saneavision/ +.I http://exactcode.com/site/open_source/saneavision .SH MAINTAINER Ren\['e] Rebe + .SH AUTHOR Ren\['e] Rebe and Meino Christian Cramer diff --git a/doc/sane-bh.man b/doc/sane-bh.man index 2c0fadc..de1336e 100644 --- a/doc/sane-bh.man +++ b/doc/sane-bh.man @@ -11,7 +11,7 @@ provides access to Bell+Howell Copiscan II series document scanners. The Copiscan II 6338 has been the primary scanner model used during development and testing, but since the programming interface for the entire series is consistent the backend should work for the -following scanner models. +following scanner models: .PP .RS COPISCAN II 6338 Duplex Scanner with ACE @@ -30,12 +30,12 @@ COPISCAN II 3338(A) Simplex Scanner (with ACE) .PP If you have a Bell+Howell scanner and are able to test it with this backend, please contact -.IR sane\-devel@alioth-lists.debian.net +.I sane\-devel@alioth-lists.debian.net with the model number and testing results. Have a look at -http://www.sane\-project.org/mailing\-lists.html concerning subscription to -sane\-devel. Additionally, the author is curious as to the likelihood of using -this backend with the newer 4000 and 8000 series scanners. If you have such a -beast, please let me know. +.I http://www.sane\-project.org/mailing\-lists.html +concerning subscription to sane\-devel. Additionally, the author is +curious as to the likelihood of using this backend with the newer 4000 +and 8000 series scanners. If you have such a beast, please let me know. .PP The Bell+Howell Copiscan II series document scanners are high volume, high throughput scanners designed for document scanning @@ -56,7 +56,7 @@ The latest backend release, additional information and helpful hints are available from the backend homepage: .br .RS -.B http://www.martoneconsulting.com/sane\-bh.html +.I http://www.martoneconsulting.com/sane\-bh.html .RE .SH "DEVICE NAMES" This backend expects device names of the form: @@ -74,180 +74,9 @@ name takes a format such as .I /dev/sga or .IR /dev/sg0 , -for example. See sane\-scsi(5) for details. -.SH CONFIGURATION -The contents of the -.I bh.conf -file is a list of device names that correspond to Bell+Howell -scanners. See sane\-scsi(5) on details of what constitutes a valid device name. -Additionally, options can be specified; these lines begin with the word "option". -Each option is described in detail below. Empty lines and lines starting -with a hash mark (#) are ignored. - -.SH OPTIONS -The following options can be specified in the -.I bh.conf -file. -.TP -.B disable\-optional\-frames -This option prevents the backend from sending any optional frames. This -option may be useful when dealing with frontends which do not support these -optional frames. When this option is in effect, the data is sent in a -SANE_FRAME_GRAY frame. The optional frames sent by this backend are: -SANE_FRAME_G31D, SANE_FRAME_G32D, SANE_FRAME_G42D and SANE_FRAME_TEXT. -These frames are generated based on the compression and barcode options. -These frames are never sent in preview mode. -.TP -.B fake\-inquiry -This option is used for debugging purposes and its use is not encouraged. -Essentially, it allows the backend to initialize in the absence of -a scanner. This is useful for development and not much else. -This option must be specified earlier in the configuration file than -the devices which are to be "faked". - -.SH FILES -.TP -.I @CONFIGDIR@/bh.conf -The backend configuration file (see also description of -.B SANE_CONFIG_DIR -below). -.TP -.I @LIBDIR@/libsane\-bh.a -The static library implementing this backend. -.TP -.I @LIBDIR@/libsane\-bh.so -The shared library implementing this backend (present on systems that -support dynamic loading). -.SH ENVIRONMENT -.TP -.B SANE_CONFIG_DIR -This environment variable specifies the list of directories that may -contain the configuration file. Under UNIX, the directories are -separated by a colon (`:'), under OS/2, they are separated by a -semi-colon (`;'). If this variable is not set, the configuration file -is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the -environment variable ends with the directory separator character, then -the default directories are searched after the explicitly specified -directories. For example, setting -.B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). -.TP -.B SANE_DEBUG_BH -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 "SUPPORTED FEATURES" -.TP -.B ADF support -With document scanners, automatic document feeder (ADF) support is a key -feature. The backend supports the ADF by default and returns -.B SANE_STATUS_NO_DOCS -when the out-of-paper condition is detected. The SANE frontend -.B scanadf -is a command line frontend that supports multi-page scans. It has been -used successfully with this backend. The SANE frontend -.B xsane -is an improved GUI frontend by Oliver Rauch. Support for multi-page -scans is included in xsane version 0.35 and above. - -.TP -.B Duplex scanning -Some models, such as the COPISCAN II 6338, support duplex scanning. That -is, they scan both sides of the document during a single pass through the -scanner (the scanner has two cameras). This backend supports duplex -scanning (with the -.B \-\-duplex -option). The front and back page images are delivered consecutively -as if they were separately scanned pages. - -.TP -.B Hardware compression -The scanner is capable of compressing the data into several industry -standard formats (CCITT G3, CCITT G3-2D, CCITT G4). This results in -increased performance as less data is passed from the scanner to the -host over the SCSI bus. The backend supports these compression formats -via the -.B \-\-g31d, \-\-g32d, \-\-g42d -options, respectively. Many SANE frontends are not equipped to deal with -these formats, however. The SANE frontend -.B scanadf -supports these optional frame formats. The compressed image data -is written directly to a file and can then be processed by a scan-script -using the -.B \-\-scan\-script -option. Examples of this are given on the scanadf homepage. - -.TP -.B Automatic Border Detection -The scanner can automatically detect the paper size and adjust the -scanning window geometry appropriately. The backend supports this -useful feature with the -.B \-\-autoborder -option. It is enabled by default. - -.TP -.B Batch Mode Scanning -The batch scan mode allows for maximum throughput. The Set Window -parameters must remain constant during the entire batch. - -.TP -.B Icon Generation -The Icon function generates a thumbnail of the full page image, that can be -transferred as if it were a separate page. This allows the host to -quickly display a thumbnail representation during the scanning operation. -Perhaps this would be a great way of implementing a preview scan, but -since a normal scan is so quick, it might not be worth the trouble. - -.TP -.B Multiple Sections -Multiple sections (scanning sub-windows) can be defined for the front and -back pages. Each section can have different characteristics (e.g. geometry, -compression). The sections are returned as if they were separately -scanned images. Additionally sections can be used to greatly enhance the -accuracy and efficiency of the barcode/patchcode decoding process by -limiting the search area to a small subset of the page. Most Copiscan II -series scanners support up to 8 user-defined sections. - -.TP -.B Support Barcode/Patchcode Decoding -The RSC unit can recognize Bar and Patch Codes of various types embedded -in the scanned image. The codes are decoded and the data is returned to -the frontend as a text frame. The text is encoded in xml and contains -a great deal of information about the decoded data such as the location -where it was found, its orientation, and the time it took to find. -Further information on the content of this text frame as well as some -barcode decoding examples can be found on the backend homepage. - -.SH LIMITATIONS -.TP -.B Decoding a single barcode type per scan -The RSC unit can search for up to six different barcode types at a time. -While the code generally supports this as well, the -.B \-\-barcode\-search\-bar -option only allows the user to specify a single barcode type. -Perhaps another option which allows a comma separated list of barcode -type codes could be added to address this. -.TP -.B Scanning a fixed number of pages in batch mode -The separation of front and back end functionality in SANE presents a -problem in supporting the 'cancel batch' functionality in the scanner. -In batch mode, the scanner is always a page ahead of the host. The host, -knowing ahead of time which page will be the last, can cancel batch mode -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 \-\-end\-count terminates a scanadf 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 -\-\-batch=no when scanning a fixed number of pages. -.TP -.B Revision 1.2 Patch detector -There is an enhanced patchcode detection algorithm available in the RSC -with revision 1.2 or higher that is faster and more reliable than the -standard Bar/Patch code decoder. This is not currently supported. +for example. See +.BR sane\-scsi (5) +for details. .SH OPTIONS .TP @@ -256,7 +85,8 @@ standard Bar/Patch code decoder. This is not currently supported. .B \-\-preview[=(yes|no)] [no] Request a preview-quality scan. When preview is set to yes image compression is disabled and the image is delivered in a -SANE_FRAME_GRAY frame. +.B SANE_FRAME_GRAY +frame. .TP .B \-\-mode lineart|halftone [lineart] Selects the scan mode (e.g., lineart,monochrome, or color). @@ -268,6 +98,7 @@ a list of standard resolutions; only these resolutions can be used. .B \-\-compression none|g31d|g32d|g42d [none] Sets the compression mode of the scanner. Determines the type of data returned from the scanner. Values are: + .RS .br .B none @@ -282,7 +113,9 @@ returned from the scanner. Values are: .B g42d \- CCITT G4 (MMR) \- delivered in a SANE_FRAME_G42D frame .br -NOTE: The use of g31d, g32d, and g42d compression values causes the backend + +.BR NOTE : +The use of g31d, g32d, and g42d compression values causes the backend to generate optional frame formats which may not be supported by all SANE frontends. .RE @@ -314,7 +147,8 @@ Bottom-right y position of scan area. .TP .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 xsane; it has no other purpose. +to allow multiple image scans with +.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 @@ -385,6 +219,7 @@ Length of icon (thumbnail) image in pixels. Specifies the barcode type to search for. If this option is not specified, or specified with a value of none, then the barcode decoding feature is completely disabled. The valid barcode type are: + .RS .br .B none @@ -428,6 +263,7 @@ to its maximum value (7). .B \-\-barcode\-search\-mode <see list> [horiz\-vert] Chooses the orientation of barcodes to be searched. The valid orientations are: + .RS .br .B horiz\-vert @@ -474,7 +310,8 @@ Ordinarily barcodes are searched in the entire image. However, when you specify sections all barcode searching is done within the specific sections identified. This can significantly speed up the decoding process. -The following functioncodes are available: +The following function codes are available: + .RS .br .B front @@ -530,18 +367,215 @@ there are more white pixels in the code. .B \-\-barcode\-patchmode 0..1 [0] Controls Patch Code detection. +.SH CONFIGURATION +The contents of the +.I bh.conf +file is a list of device names that correspond to Bell+Howell +scanners. See +.BR sane\-scsi (5) +on details of what constitutes a valid device name. +Additionally, options can be specified; these lines begin with the word "option". +Each option is described in detail below. Empty lines and lines starting +with a hash mark (#) are ignored. + +.SH OPTIONS +The following options can be specified in the +.I bh.conf +file. +.TP +.B disable\-optional\-frames +This option prevents the backend from sending any optional frames. This +option may be useful when dealing with frontends which do not support these +optional frames. When this option is in effect, the data is sent in a +.B SANE_FRAME_GRAY +frame. The optional frames sent by this backend are: +.BR SANE_FRAME_G31D ", " SANE_FRAME_G32D ", " SANE_FRAME_G42D " and " SANE_FRAME_TEXT . +These frames are generated based on the compression and barcode options. +These frames are never sent in preview mode. +.TP +.B fake\-inquiry +This option is used for debugging purposes and its use is not encouraged. +Essentially, it allows the backend to initialize in the absence of +a scanner. This is useful for development and not much else. +This option must be specified earlier in the configuration file than +the devices which are to be "faked". + +.SH FILES +.TP +.I @CONFIGDIR@/bh.conf +The backend configuration file (see also description of +.B SANE_CONFIG_DIR +below). +.TP +.I @LIBDIR@/libsane\-bh.a +The static library implementing this backend. +.TP +.I @LIBDIR@/libsane\-bh.so +The shared library implementing this backend (present on systems that +support dynamic loading). + +.SH ENVIRONMENT +.TP +.B SANE_CONFIG_DIR +This environment variable specifies the list of directories that may +contain the configuration file. Under UNIX, the directories are +separated by a colon (`:'), under OS/2, they are separated by a +semi-colon (`;'). If this variable is not set, the configuration file +is searched in two default directories: first, the current working +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory +separator character, then the default directories are searched after +the explicitly specified directories. For example, setting +.B SANE_CONFIG_DIR +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). +.TP +.B SANE_DEBUG_BH +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 "SUPPORTED FEATURES" +.TP +.B ADF support +With document scanners, automatic document feeder (ADF) support is a key +feature. The backend supports the ADF by default and returns +.B SANE_STATUS_NO_DOCS +when the out-of-paper condition is detected. The SANE frontend +.BR scanadf (1) +is a command line frontend that supports multi-page scans. It has been +used successfully with this backend. The SANE frontend +.BR xsane (1) +is an improved GUI frontend by Oliver Rauch. Support for multi-page +scans is included in xsane version 0.35 and above. + +.TP +.B Duplex scanning +Some models, such as the COPISCAN II 6338, support duplex scanning. That +is, they scan both sides of the document during a single pass through the +scanner (the scanner has two cameras). This backend supports duplex +scanning (with the +.B \-\-duplex +option). The front and back page images are delivered consecutively +as if they were separately scanned pages. + +.TP +.B Hardware compression +The scanner is capable of compressing the data into several industry +standard formats (CCITT G3, CCITT G3-2D, CCITT G4). This results in +increased performance as less data is passed from the scanner to the +host over the SCSI bus. The backend supports these compression formats +via the +.B \-\-g31d, \-\-g32d, \-\-g42d +options, respectively. Many SANE frontends are not equipped to deal with +these formats, however. The SANE frontend +.BR scanadf (1) +supports these optional frame formats. The compressed image data +is written directly to a file and can then be processed by a scan-script +using the +.B \-\-scan\-script +option. Examples of this are given on the +.BR scanadf (1) +homepage. + +.TP +.B Automatic Border Detection +The scanner can automatically detect the paper size and adjust the +scanning window geometry appropriately. The backend supports this +useful feature with the +.B \-\-autoborder +option. It is enabled by default. + +.TP +.B Batch Mode Scanning +The batch scan mode allows for maximum throughput. The Set Window +parameters must remain constant during the entire batch. + +.TP +.B Icon Generation +The Icon function generates a thumbnail of the full page image, that can be +transferred as if it were a separate page. This allows the host to +quickly display a thumbnail representation during the scanning operation. +Perhaps this would be a great way of implementing a preview scan, but +since a normal scan is so quick, it might not be worth the trouble. + +.TP +.B Multiple Sections +Multiple sections (scanning sub-windows) can be defined for the front and +back pages. Each section can have different characteristics (e.g. geometry, +compression). The sections are returned as if they were separately +scanned images. Additionally sections can be used to greatly enhance the +accuracy and efficiency of the barcode/patchcode decoding process by +limiting the search area to a small subset of the page. Most Copiscan II +series scanners support up to 8 user-defined sections. + +.TP +.B Support Barcode/Patchcode Decoding +The RSC unit can recognize Bar and Patch Codes of various types embedded +in the scanned image. The codes are decoded and the data is returned to +the frontend as a text frame. The text is encoded in xml and contains +a great deal of information about the decoded data such as the location +where it was found, its orientation, and the time it took to find. +Further information on the content of this text frame as well as some +barcode decoding examples can be found on the backend homepage. + +.SH LIMITATIONS +.TP +.B Decoding a single barcode type per scan +The RSC unit can search for up to six different barcode types at a time. +While the code generally supports this as well, the +.B \-\-barcode\-search\-bar +option only allows the user to specify a single barcode type. +Perhaps another option which allows a comma separated list of barcode +type codes could be added to address this. +.TP +.B Scanning a fixed number of pages in batch mode +The separation of front and back end functionality in SANE presents a +problem in supporting the 'cancel batch' functionality in the scanner. +In batch mode, the scanner is always a page ahead of the host. The host, +knowing ahead of time which page will be the last, can cancel batch mode +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, +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 +when scanning a fixed number of pages. +.TP +.B Revision 1.2 Patch detector +There is an enhanced patchcode detection algorithm available in the RSC +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 ;) .PP If you have found something that you think is a bug, please attempt to -recreate it with the SANE_DEBUG_BH environment variable set to -255, and send a report detailing the conditions surrounding the bug to +recreate it with the +.B SANE_DEBUG_BH +environment variable set to 255, and send a report detailing the conditions +surrounding the bug to .IR sane\-devel@alioth-lists.debian.net . .SH "SEE ALSO" -sane(7), sane\-scsi(5), scanimage(1), scanadf(1) +.BR sane (7), +.BR sane\-scsi (5), +.BR scanimage (1), +.BR scanadf (1), +.BR xsane (1) .SH AUTHOR -The sane\-bh backend was written by Tom Martone, based on the sane\-ricoh +The +.B sane\-bh backend +was written by Tom Martone, based on the +.BR sane\-ricoh (5) backend by Feico W. Dillema and the bnhscan program by Sean Reifschneider of tummy.com ltd. Some 8000 enhancements added by Mark Temple. diff --git a/doc/sane-canon.man b/doc/sane-canon.man index 6085b16..6cc23a5 100644 --- a/doc/sane-canon.man +++ b/doc/sane-canon.man @@ -24,8 +24,11 @@ CanoScan FS2710S .RE .PP Parallel port and USB scanners are not supported by this backend; see -the manual pages for sane\-canon_pp and sane\-canon630u for further -information. +the manual pages for +.BR sane\-canon_pp (5) +and +.BR sane\-canon630u (5) +for further information. .PP IMPORTANT: This is beta code. We tested the code on the scanners listed above, using the computers and operating systems available to us, but we @@ -36,25 +39,30 @@ It cannot be excluded (although we consider it extremely unlikely) that your scanner will be damaged. .PP That said, TESTERS ARE WELCOME. Send your bug reports and comments to -Manuel Panea <mpd@rzg.mpg.de>; for questions concerning the FB620 and -FB1200S contact Mitsuru Okaniwa <m\-okaniwa@bea.hi\-ho.ne.jp>, for the -FS2710S Ulrich Deiters <ukd@xenon.pc.uni\-koeln.de>. -.PP +Manuel Panea +.IR <mpd@rzg.mpg.de> ; +for questions concerning the FB620 and FB1200S contact Mitsuru Okaniwa +.IR <m\-okaniwa@bea.hi\-ho.ne.jp> , +for the FS2710S Ulrich Deiters +.IR <ukd@xenon.pc.uni\-koeln.de> . .SH TIPS (FS2700F) .PP Scanning either slides or negatives has been found to require rather large gamma corrections of about 2.2 to 2.4 (same value for red, green, and blue). It is recommended to use the automatic exposure controls -of the frontend xsane for best results. +of the frontend +.BR xsane (1) +for best results. .PP The "Auto Focus" function triggers a special pass to determine the focus value. After that, the real scanning pass takes place. .PP Even with "Auto Focus" turned on, the scanned image is often a bit too -blurred. Using the GIMP to do a "Filter->Enhance->Sharpen" at about 40 -to 60 improves the image considerably. -.PP +blurred. Using the +.BR gimp (1) +to do a "Filter->Enhance->Sharpen" at about 40 to 60 improves the image +considerably. .SH TIPS (FS2710S) .PP @@ -88,14 +96,16 @@ Example: export SANE_DEBUG_CANON=4 .SH "SEE ALSO" -sane\-scsi(5) -.br -http://www.rzg.mpg.de/~mpd/sane/ +.BR sane\-scsi (5) .br -doc/canon.install2700F.txt (installation of a CanoScan 2700F +.I http://www.rzg.mpg.de/~mpd/sane/doc/canon.install2700F.txt +(installation of a CanoScan 2700F) .br .SH AUTHOR -Helmut Koeberle, Manuel Panea, and Markus Mertinat; FB620S and FB1200S support -by Mitsuru Okaniwa; FS2710S support by Ulrich Deiters +Helmut Koeberle, Manuel Panea, and Markus Mertinat; +.br +FB620S and FB1200S support by Mitsuru Okaniwa; +.br +FS2710S support by Ulrich Deiters .br Man page by Henning Meier-Geinitz (mostly based on canon.README) diff --git a/doc/sane-canon630u.man b/doc/sane-canon630u.man index e9ec3cd..f569695 100644 --- a/doc/sane-canon630u.man +++ b/doc/sane-canon630u.man @@ -19,7 +19,8 @@ Color scanning is supported at 75, 150, 300, and 600 dpi, and gamma and analog gain are adjustable. .PP TESTERS ARE WELCOME. Send your bug reports and comments to -Nathan Rutman <nthn1@yahoo.com> +Nathan Rutman +.IR <nthn1@yahoo.com> . .PP .SH CONFIGURATION The contents of the @@ -29,15 +30,19 @@ USB scanners. Empty lines and lines starting with a hash mark (#) are ignored. Only one device name can be listed in .IR canon630u.conf . The program -.IR sane\-find\-scanner +.BR sane\-find\-scanner (1) helps to find out the correct device. Under Linux, such a device name could be .I /dev/usb/scanner0 -for example. See sane\-usb(5) for details. +for example. See +.BR sane\-usb (5) +for details. .PP This product-specific scanner driver uses the lower-level kernel USB driver -"scanner". Check for "Driver=usbscanner" under /proc/bus/usb/devices. If -"Driver=(none)", try forcing it with "insmod scanner vendor=0x04a9 product=0x2204" +"scanner". Check for "Driver=usbscanner" under +.IR /proc/bus/usb/devices. +If "Driver=(none)", try forcing it with +.I "insmod scanner vendor=0x04a9 product=0x2204" .SH NOTES .PP Due to Canon's unwillingness to provide scanner documentation, this @@ -49,10 +54,16 @@ This driver requires the ability to send USB Control Messages, available in kernel 2.4.12 or later. .PP Some users have reported that this driver doesn't work at all. This seems -to be a hardware specific issue, although I don't know what exactly the +to be a hardware specific issue, although I dsane\-uson't know what exactly the problem is. If you are having problems, please send me the info in -/proc/bus/usb/devices, /proc/pci, the kernel scanner.c driver version from -/var/log/messages, and the output from "SANE_DEBUG_CANON630U=12 scanimage > /dev/null" +.IR /proc/bus/usb/devices, +.IR /proc/pci, +the kernel +.I scanner.c +driver version from +.IR /var/log/messages, +and the output from +.I "SANE_DEBUG_CANON630U=12 scanimage > /dev/null" .PP .SH FILES .TP @@ -80,13 +91,18 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the -environment variable ends with the directory separator character, then -the default directories are searched after the explicitly specified -directories. For example, setting +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory +separator character, then the default directories are searched after +the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_CANON630U If the library was compiled with debug support enabled, this @@ -97,9 +113,11 @@ Example: .br SANE_DEBUG_CANON630U=12 scanimage > /dev/null .SH "SEE ALSO" -sane(7), sane\-usb(5), sane\-find\-scanner(1) +.BR sane (7), +.BR sane\-usb (5), +.BR sane\-find\-scanner (1) .br -http://canon-fb630u.sourceforge.net/ +.I http://canon-fb630u.sourceforge.net/ .br .SH AUTHOR Nathan Rutman diff --git a/doc/sane-canon_dr.man b/doc/sane-canon_dr.man index 4fbc635..db483e0 100644 --- a/doc/sane-canon_dr.man +++ b/doc/sane-canon_dr.man @@ -14,8 +14,8 @@ This document describes backend version 57, which shipped with SANE 1.0.28. .SH SUPPORTED HARDWARE This version has only been tested with a few scanner models. Please see -http://www.sane\-project.org/sane\-supported\-devices.html for the most recent -list. +.I http://www.sane\-project.org/sane\-supported\-devices.html +for the most recent list. This backend may support other Canon scanners. The best way to determine level of support is to test the scanner directly, @@ -31,35 +31,32 @@ no way to detect if they are required, so they must be hard-coded. .SH OPTIONS Effort has been made to expose most hardware options, including: -.PP -source s -.RS -Selects the source for the scan. Options -may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex". -.RE -.PP -mode m -.RS -Selects the mode for the scan. Options -may include "Lineart", "Halftone", "Gray", and "Color". -.RE -.PP -resolution -.RS +.TP +.B \-\-source Flatbed|ADF Front|ADF Back|ADF Duplex +Selects the source for the scan. + +.TP +.B \-\-mode Lineart|Halftone|Gray|Color +Selects the mode for the scan. + +.TP +.B \-\-resolution Controls scan resolution. -.RE -.PP -tl\-x, tl\-y, br\-x, br\-y -.RS + +.TP +.B \-\-tl\-x, \-\-tl\-y, \-\-br\-x, \-\-br\-y Sets scan area upper left and lower right coordinates. These are renamed -t, l, x, y by some frontends. -.RE -.PP -page\-width, page\-height -.RS +.BR -t , +.BR -l , +.BR -x , +.B -y +by some frontends. + +.TP +.B \-\-page\-width, \-\-page\-height Sets paper size. Used by scanner to determine centering of scan coordinates when using ADF and to detect double feed errors. -.RE + .PP Other options will be available based on the capabilities of the scanner: enhancement, compression, buttons and sensors, etc. @@ -71,41 +68,40 @@ capabilities. Please note that these features are somewhat simplistic, and may not perform as well as the native implementations. Note also that these features all require that the driver cache the entire image in memory. This will almost certainly result in a reduction of scanning speed. -.PP -swcrop -.RS + +.TP +.B \-\-swcrop Requests the driver to detect the extremities of the paper within the larger image, and crop the empty edges. -.RE -.PP -swdeskew -.RS + +.TP +.B \-\-swdeskew Requests the driver to detect the rotation of the paper within the larger image, and counter the rotation. -.RE -.PP -swdespeck X -.RS + +.TP +.B \-\-swdespeck X Requests the driver to find and remove dots of X diameter or smaller from the image, and fill the space with the average surrounding color. -.RE Use 'scanimage \-\-help' to get a list, but be aware that some options may be settable only when another option has been set, and that advanced options may be hidden by some frontend programs. -.PP + .SH CONFIGURATION FILE -The configuration file "canon_dr.conf" is used to tell the backend how to look -for scanners, and provide options controlling the operation of the backend. -This file is read each time the frontend asks the backend for a list -of scanners, generally only when the frontend starts. If the configuration -file is missing, the backend will fail to run. +The configuration file +.I canon_dr.conf +is used to tell the backend how to look for scanners, and provide options +controlling the operation of the backend. This file is read each time the +frontend asks the backend for a list of scanners, generally only when the +frontend starts. If the configuration file is missing, the backend will +fail to run. .PP Scanners can be specified in the configuration file in 4 ways: .PP "scsi CANON DR" .RS -Requests backend to search all scsi busses in the system for a device +Requests backend to search all scsi buses in the system for a device which reports itself to be a scanner made by 'CANON', with a model name starting with 'DR'. .RE @@ -119,7 +115,7 @@ specify one. Probably should not be used with the other "scsi" line above. .PP "usb 0x04a9 0x1603" (or other vendor/product ids) .RS -Requests backend to search all usb busses in the system for a device +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 Canon scanner. .RE @@ -164,13 +160,15 @@ Some scanners prepend all data transmitted to host with 12 bytes. Enable this op Some scanners pad the upper edge of one side of a duplex scan. There is some variation in the amount of padding. Modify this option if your unit shows an unwanted band of image data on only one side. .RE .PP -Note: 'option' lines may appear multiple times in the configuration file. +.BR NOTE : +'option' lines may appear multiple times in the configuration file. They only apply to scanners discovered by the next 'scsi/usb' line. .PP .SH ENVIRONMENT -The backend uses a single environment variable, SANE_DEBUG_CANON_DR, which -enables debugging output to stderr. Valid values are: +The backend uses a single environment variable, +.BR SANE_DEBUG_CANON_DR , +which enables debugging output to stderr. Valid values are: .PP .RS 5 Errors @@ -195,26 +193,39 @@ machines have not been tested. Their protocol is unknown. .SH CREDITS -The various authors of the sane\-fujitsu backend provided useful code +The various authors of the +.BR sane\-fujitsu (5) +backend provided useful code. .br -Yabarana Corp. www.yabarana.com provided significant funding +Yabarana Corp. +.I www.yabarana.com +provided significant funding. .br -EvriChart, Inc. www.evrichart.com provided funding and loaned equipment +EvriChart, Inc. +.I www.evrichart.com +provided funding and loaned equipment. .br -Canon, USA. www.usa.canon.com loaned equipment +Canon, USA. +.I www.usa.canon.com +loaned equipment. .br -HPrint hprint.com.br provided funding and testing for DR-2510 support +HPrint +.I hprint.com.br +provided funding and testing for DR-2510 support. .br -Stone-IT www.stone-it.com provided funding for DR-2010 and DR-2050 support +Stone-IT +.I www.stone-it.com +provided funding for DR-2010 and DR-2050 support. .br -Gerhard Pfeffer provided access and testing for P-208 and P-215 +Gerhard Pfeffer provided access and testing for P-208 and P-215. .br Special thanks to: Alejandro Imass, Andre Shimakawa, Martijn van Brummelen, Thanos Diacakis and Junren Shi for testing and feedback. .SH "SEE ALSO" -sane(7), -sane\-scsi(5), -sane\-usb(5) +.BR sane (7), +.BR sane\-scsi (5), +.BR sane\-usb(5) .SH AUTHOR -m. allan noah: <kitno455 a t gmail d o t com> +m. allan noah: +.IR "<kitno455 a t gmail d o t com>" . diff --git a/doc/sane-canon_lide70.man b/doc/sane-canon_lide70.man index ae807a3..83c54bc 100644 --- a/doc/sane-canon_lide70.man +++ b/doc/sane-canon_lide70.man @@ -1,12 +1,13 @@ -.TH sane\-canon_lide70 5 "26 Nov 2019" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.TH sane\-canon_lide70 5 "22 Aug 2020" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" .IX sane\-canon_lide70 .SH NAME -sane\-canon_lide70 \- SANE backend for the Canon LiDE 70 USB flatbed scanner +sane\-canon_lide70 \- SANE backend for the Canon LiDE 70 and 600(F) USB flatbed scanners .SH DESCRIPTION The .B canon_lide70 library implements a SANE (Scanner Access Now Easy) backend that -provides access to the Canon Inc. CanoScan LiDE 70 flatbed scanner. +provides access to the Canon Inc. CanoScan LiDE 70 and 600(F) +flatbed scanners. The film unit of the LiDE 600F is not supported. .PP Due to Canon's unwillingness to provide scanner documentation, this software was developed by analyzing the USB traffic of the Windows @@ -15,55 +16,51 @@ to the scanner is known only to a very limited extent. Some sophistication present in the Windows XP driver has been left out. There is, for example, no active calibration. .PP -TESTERS ARE WELCOME. Send your bug reports and comments to -the sane\-devel mailing list <sane\-devel@alioth-lists.debian.net> -.PP -The -.B Canoscan LiDE 600 -(or 600f, with film unit) is closely related to the LiDE 70, but -it does not work with this backend. Support for the LiDE 600 will -be added by the end of 2020. +Testers and reviewers are welcome. Send your bug reports and comments to +the sane\-devel mailing list +.IR <sane\-devel@alioth-lists.debian.net> . .PP .SH CONFIGURATION The .I @CONFIGDIR@/canon_lide70.conf file identifies the LiDE 70 by its vendor code 0x04a9 and its -product code 0x2225. For the LiDE 600(f) the product code would be 0x2224. -.PP +product code 0x2225. For the LiDE 600(f) the product code is 0x2224. + .SH BACKEND SPECIFIC OPTIONS -.PP .B Scan Mode: + .TP -\-\-resolution 75|150|300|600|1200 [default 600] -.BR -Sets the resolution of the scanned image in dots per inch. Scanning at 1200 dpi is very slow. +.B \-\-resolution 75|150|300|600|1200 [default 600] +Sets the resolution of the scanned image in dots per inch. Scanning at 1200 dpi +is not available on the LiDE 600(F) and it is very slow on the LiDE 70. + .TP -\-\-mode Color|Gray|Lineart [default: Color] -.BR +.B \-\-mode Color|Gray|Lineart [default: Color] Selects the scan mode. Lineart means fully black and fully white pixels only. + .TP -\-\-threshold 0..100 (in steps of 1) [default 75] -.BR +.B \-\-threshold 0..100 (in steps of 1) [default 75] Select minimum-brightness percentage to get a white point, relevant only for Lineart + .TP -\-\-non-blocking[=(yes|no)] [inactive] -.BR +.B \-\-non-blocking[=(yes|no)] [inactive] This option has not yet been implemented. Scans are captured in a temporary file with a typical size of 100MB. + .PP .B Geometry: .TP -\-l 0..216.069 [default 0] - Top-left x position of scan area in millimeters. +.B \-l 0..216.069 [default 0] +Top-left x position of scan area in millimeters. .TP -\-t 0..297 [default 0] - Top-left y position of scan area in millimeters. +.B \-t 0..297 [default 0] +Top-left y position of scan area in millimeters. .TP -\-x 0..216.069 [default 80] - Width of scan-area in millimeters. +.B \-x 0..216.069 [default 80] +Width of scan-area in millimeters. .TP -\-y 0..297 [default 100] - Height of scan-area in millimeters. -.PP +.B \-y 0..297 [default 100] +Height of scan-area in millimeters. + .SH FILES .TP .I @CONFIGDIR@/canon_lide70.conf @@ -87,18 +84,27 @@ Example: SANE_DEBUG_CANON_LIDE70=128 scanimage > /dev/null .SH KNOWN PROBLEMS At low resolutions (75 and 150 dpi, implying high slider speeds) -the scanner misses the top one millimeter of the scan area. This can +the LiDE 70 misses the top one millimeter of the scan area. This can be remedied by shifting the document one millimeter downward, in cases -where such precision matters. Note that xsane uses the 75 dpi mode for -prescans. +where such precision matters. Note that +.BR xsane (1) +uses the 75 dpi mode for prescans. The problem is worse on the LiDE 600(F), +where the offset is five millimeters. .PP -It is recommended that in xsane the gamma value be set to approximately 1.5 +It is recommended that in +.BR xsane (1) +the gamma value be set to approximately 1.7 to get more realistic colors. This also wipes out some artifacts caused by the lack of real calibration. + .SH "SEE ALSO" -sane(7), sane\-usb(5), sane\-find\-scanner(1), scanimage(1) +.BR sane (7), +.BR sane\-usb (5), +.BR sane\-find\-scanner (1), +.BR scanimage (1), +.BR xsane (1), .br http://www.juergen-ernst.de/info_sane.html -.br + .SH AUTHOR pimvantend, building upon pioneering work by Juergen Ernst. diff --git a/doc/sane-canon_pp.man b/doc/sane-canon_pp.man index 46bb823..72a9381 100644 --- a/doc/sane-canon_pp.man +++ b/doc/sane-canon_pp.man @@ -27,7 +27,7 @@ CanoScan N640P ex .PP No USB scanners are supported and there are no plans to support them in the future. Other projects are working on support for USB scanners. See the -.B PROJECTS +.I PROJECTS file for more detail. The FB310P and FB610P are re-badged Avision scanners which use a different command set, so are unlikely to be supported by this backend in the future. @@ -38,12 +38,11 @@ appreciated. Please send any bug reports to the maintainers as listed on the web page (listed in .B SEE ALSO below). -.PP -. -.PP + .SH "DEVICE NAMES" -This backend expects device names of the form presented by libieee1284. These -names are highly dependent on operating system and version. +This backend expects device names of the form presented by +.BR libieee1284 (3). +These names are highly dependent on operating system and version. On Linux 2.4 kernels this will be of the form .I "parport0" @@ -136,13 +135,18 @@ This environment variable specifies the list of directories that may contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: -first, the current working directory (".") and then in @CONFIGDIR@. If the -value of the environment variable ends with the directory separator character, -then the default directories are searched after the explicitly specified -directories. For example, setting +first, the current working directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator +character, then the default directories are searched after the explicitly +specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_CANON_PP If the library was compiled with debug support enabled, this environment @@ -219,9 +223,11 @@ but not where another scan can be made. .SH "SEE ALSO" -sane(7), sane\-dll(5) -.BR -http://canon\-fb330p.sourceforge.net/ +.BR sane (7), +.BR sane\-dll(5), +.BR libieee1284 (3), +.br +.I http://canon\-fb330p.sourceforge.net/ .SH AUTHOR This backend is primarily the work of Simon Krix (Reverse Engineering), and diff --git a/doc/sane-cardscan.man b/doc/sane-cardscan.man index e5872a8..5d29efe 100644 --- a/doc/sane-cardscan.man +++ b/doc/sane-cardscan.man @@ -19,14 +19,15 @@ driver in action, and send it to the author. .SH OPTIONS The cardscan backend supports the following options: -.PP -mode m -.RS -Selects the mode for the scan. Options are "Gray" and "Color". -.RE -.PP + +.TP +.B --mode Gray|Color +Selects the mode for the scan. + .SH CONFIGURATION FILE -The configuration file "cardscan.conf" is used to tell the backend how to look +The configuration file +.I cardscan.conf +is used to tell the backend how to look for scanners, and provide options controlling the operation of the backend. This file is read each time the frontend asks the backend for a list of scanners, generally only when the frontend starts. If the configuration @@ -37,7 +38,7 @@ Scanners can be specified in the configuration file in 2 ways: .PP "usb 0x04c5 0x1042" (or other vendor/product ids) .RS -Requests backend to search all usb busses in the system for a device +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 cardscan scanner. .RE @@ -64,8 +65,9 @@ Older scanners do not support this request, and must be set to 0. .RE .SH ENVIRONMENT -The backend uses a single environment variable, SANE_DEBUG_CARDSCAN, which -enables debugging output to stderr. Valid values are: +The backend uses a single environment variable, +.BR SANE_DEBUG_CARDSCAN, +which enables debugging output to stderr. Valid values are: .PP .RS 5 Errors @@ -103,11 +105,13 @@ windows driver. .SH CREDITS The hardware to build this driver was provided to the author by: - Jeff Kowalczyk <jtk a t yahoo d o t com> +Jeff Kowalczyk +.IR "<jtk a t yahoo d o t com>" . .SH "SEE ALSO" -sane(7), -sane\-usb(5) +.BR sane (7), +.BR sane\-usb (5) .SH AUTHOR -m. allan noah: <kitno455 a t gmail d o t com> +m. allan noah: +.I "<kitno455 a t gmail d o t com>" . diff --git a/doc/sane-config.man b/doc/sane-config.man index 997a342..aa6cd69 100644 --- a/doc/sane-config.man +++ b/doc/sane-config.man @@ -7,11 +7,7 @@ sane\-config \- get information about the installed version of libsane .PP .B sane\-config is a tool that is used to determine the compiler and linker -flags that should be used to compile and link -.B SANE -frontends to a -.B SANE -backend library (libsane). +flags that should be used to compile and link SANE frontends to a SANE backend library (libsane). . .SH OPTIONS .B sane\-config @@ -21,31 +17,31 @@ accepts the following options (you can't use more than one option at the same ti Print the currently installed version of libsane on the standard output. .TP 8 .B \-\-help OPTION -Print a short usage message. If OPTION is specified, help for that option -(e.g. \-\-libs) is printed (if available). +Print a short usage message. If +.I OPTION +is specified, help for that option (e.g. +.BR \-\-libs ) +is printed (if available). .TP 8 .B \-\-libs -Print the additional libraries that are necessary to link a -.B SANE -frontend to libsane. +Print the additional libraries that are necessary to link a SANE frontend to libsane. .TP 8 .B \-\-ldflags -Print the linker flags that are necessary to link a -.B SANE -frontend to libsane. +Print the linker flags that are necessary to link a SANE frontend to libsane. .TP 8 .B \-\-cflags -Print the compiler flags that are necessary to compile a -.B SANE -frontend. +Print the compiler flags that are necessary to compile a SANE frontend. .TP 8 .B \-\-prefix Print the prefix used during compilation of libsane. .TP 8 .B \-\-exec\-prefix Print the exec\-prefix used during compilation of libsane. + .SH "SEE ALSO" .BR sane (7) + .SH AUTHOR -This manual page was written by Julien BLACHE <jblache@debian.org>, for the -Debian GNU/Linux system (but may be used by others). +This manual page was written by Julien BLACHE +.RI < jblache@debian.org > , +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/sane-coolscan.man b/doc/sane-coolscan.man index 65c8d53..7f73dd4 100644 --- a/doc/sane-coolscan.man +++ b/doc/sane-coolscan.man @@ -6,22 +6,27 @@ sane\-coolscan \- SANE backend for Nikon film-scanners .SH ABOUT THIS FILE -This file is a short description of the coolscan-backend for sane! +This file is a short description of the coolscan backend for +.BR SANE . .SH DESCRIPTION The .B sane\-coolscan -library implements a SANE backend that provides the interface to the following Nikon Coolscan Film scanners: Nikon LS20, LS30, LS1000, LS2000. +library implements a SANE backend that provides the interface to the following Nikon +Coolscan Film scanners: Nikon LS20, LS30, LS1000, LS2000. -.B Even though the backend has worked for a number of people, there are still some problems, especially in combination with some SCSI card/drivers (AHA-1505/aha152x.o) and the autofocus command. You should consider this backend 'alpha' and be careful when using it the first time. +.B Even though the backend has worked for a number of people, there are still some +problems, especially in combination with some SCSI card/drivers (AHA-1505/aha152x.o) +and the autofocus command. +You should consider this backend 'alpha' and be careful when using it the first time. .SH CONFIGURATION The configuration file for this backend resides in .IR @CONFIGDIR@/coolscan.conf . -Its contents is a list of device names that correspond to Nikon Coolscan scanners. Empty lines +Its content is a list of device names that correspond to Nikon Coolscan scanners. Empty lines and lines starting with a hash mark (#) are ignored. A sample configuration file is shown below: @@ -32,20 +37,18 @@ shown below: .fi The special device name must be a generic SCSI device or a symlink to such a device. -To find out to which device your scanner is assigned and how you have to set the -permissions of that device, have a look at sane\-scsi. +To find out to which device your scanner is assigned and how you can set the +permissions of that device, have a look at +.BR sane\-scsi (5). .SH SCSI ADAPTER TIPS Some SCSI-adapters and low-level SCSI drivers do not work correctly with this backend and the Coolscan scanners. These systems hang when the autofocus command is send to the Scanner. To see a list of which card/driver combinations work or don't work have a look at: -http://andreas.rick.free.fr/sane/autofocus.html. - - +.I http://andreas.rick.free.fr/sane/autofocus.html. .SH FILES - .TP The backend configuration file: .I @CONFIGDIR@/coolscan.conf @@ -63,42 +66,39 @@ The shared library implementing this backend: .B SANE_DEBUG_COOLSCAN 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: -SANE_DEBUG_COOLSCAN values +requests all debug output to be printed. Smaller levels reduce verbosity. Examples: -on bash: +On bash: .br export SANE_DEBUG_COOLSCAN=8 -on csh: +On csh: .br setenv SANE_DEBUG_COOLSCAN 8 .SH BUGS -The autofocus command does not work with some SCSI card/driver combinations +The autofocus command does not work with some SCSI card/driver combinations. .PP The gamma table is not implemented for the LS1000 yet. .PP -The dust-removal is not working yet +The dust-removal is not working yet. .SH SEE ALSO +.BR sane (7), +.BR sane\-scsi (5) .TP .I http://andreas.rick.free.fr/sane/ -The homepage of this backend +The homepage of this backend. .TP .I http://www.sema.be/coolscan/ -The original version of the coolscan backend by Didier -.PP -sane(7), sane\-scsi(5) +The original version of the coolscan backend by Didier. .SH THANKS TO - -.PP -Didier Carlier \- For writing the original Coolscan backend (without it I would not have started this) +Didier Carlier \- For writing the original Coolscan backend (without it I would not have started this). .PP Oliver Rauch \- For adapting xsane so quickly to the infrared stuff. .PP @@ -108,4 +108,4 @@ All the other people working on SANE. Andreas Rick .SH EMAIL-CONTACT -andreas.rick@free.fr +.I andreas.rick@free.fr diff --git a/doc/sane-coolscan2.man b/doc/sane-coolscan2.man index 71f589a..c801034 100644 --- a/doc/sane-coolscan2.man +++ b/doc/sane-coolscan2.man @@ -36,44 +36,59 @@ report successes or failures. .SH OPTIONS The options the backend supports can either be selected through command line -options to programs like scanimage or through GUI elements in xscanimage or xsane. +options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +or +.BR xsane (1). -Valid command line options and their syntax can be listed by using +Valid command line options and their syntax can be listed by using: +.PP .RS scanimage \-\-help \-d coolscan2:<interface>:<device> .RE +.PP where <interface> and <device> specify the device in question, as in the -configuration file (see next section). The \-d parameter and its argument +configuration file (see next section). The +.B \-d +parameter and its argument can be omitted to obtain information on the first scanner identified. Use -the command +the command: +.PP .RS scanimage \-L .RE +.PP to list all devices recognized by your SANE installation. The options should be fully described by the description or tooltips given by frontend. Here is a description of some of the most important options, in the -syntax with which they must be supplied to scanimage: +syntax with which they must be supplied to +.BR scanimage (1): .TP -.I \-\-frame <n> +.B \-\-frame <n> This option specifies which frame to operate on, if a motorized film strip feeder or APS adapter are used. The frame number .I <n> ranges from 1 to the number of frames available, which is sensed each time the backend is initialized (usually each time you start the frontend). .TP -.I \-\-subframe <x> +.B \-\-subframe <x> This option shifts the scan window by the specified amount (default unit is mm). .TP -.I \-\-infrared=yes/no +.B \-\-infrared=yes/no 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 batch\-count=2 to obtain the -IR information. +If you use +.BR scanimage (1), +perform a batch scan with +.B batch\-count=2 +to obtain the IR information. .TP -.I \-\-depth <n> +.B \-\-depth <n> Here <n> can either be 8 or the maximum number of bits supported by the scanner (10, 12, or 14). It specifies whether or not the scanner reduces the scanned data to 8 bits before sending it to the backend. If 8 bits are @@ -81,40 +96,42 @@ used, some information and thus image quality is lost, but the amount of data is smaller compared to higher depths. Also, many imaging programs and image formats cannot handle depths greater than 8 bits. .TP -.I \-\-autofocus +.B \-\-autofocus Perform autofocus operation. Unless otherwise specified by the other options ( -.I \-\-focus\-on\-centre +.B \-\-focus\-on\-centre and friends), focusing is performed on the centre of the selected scan area. .TP -.I \-\-ae\-wb +.B \-\-ae\-wb .TP -.I \-\-ae +.B \-\-ae Perform a pre-scan to calculate exposure values automatically. -.I \-\-ae\-wb +.B \-\-ae\-wb will maintain the white balance, while -.I \-\-ae +.B \-\-ae will adjust each channel separately. .TP -.I \-\-exposure +.B \-\-exposure Multiply all exposure times with this value. This allows exposure correction without modifying white balance. .TP -.I \-\-load +.B \-\-load Load the next slide when using the slide loader. .TP -.I \-\-eject +.B \-\-eject Eject the film strip or mounted slide when using the slide loader. .TP -.I \-\-reset +.B \-\-reset Reset scanner. The scanner will perform the same action as when power is turned on: it will eject the film strip and calibrate itself. Use this whenever the scanner refuses to load a film strip properly, as a result of which -.I \-\-eject +.B \-\-eject does not work. .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/coolscan2.conf specifies the device(s) +The configuration file +.I @CONFIGDIR@/coolscan2.conf +specifies the device(s) that the backend will use. Owing to the nature of the supported connection types SCSI, USB, and IEEE 1394, the default configuration file supplied with the SANE distribution should work without being edited. @@ -127,7 +144,7 @@ These lines are ignored, thus '#' can be used to include comments. .TP .I containing only the word """auto""" This instructs the backend to probe for a scanner by scanning the buses for -devices with know identifiers. This is the action taken when no +devices with known identifiers. This is the default action when no configuration file is present. .TP .I a line of the form <interface>:<device> @@ -157,7 +174,11 @@ a value of 128 requests all debug output to be printed. Smaller levels reduce verbosity. .SH "SEE ALSO" -sane\-scsi(5), sane\-usb(5), scanimage(1), xscanimage(1), xsane(1) +.BR sane\-scsi (5), +.BR sane\-usb (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1) .SH BUGS Currently, the SANE protocol does not allow automatically updating options @@ -179,4 +200,4 @@ or the SANE developers' email list. .SH AUTHORS The backend is written and maintained by Andr\['a]s Major -(andras@users.sourceforge.net). +.IR <andras@users.sourceforge.net> . diff --git a/doc/sane-coolscan3.man b/doc/sane-coolscan3.man index 238f127..57c0652 100644 --- a/doc/sane-coolscan3.man +++ b/doc/sane-coolscan3.man @@ -31,49 +31,62 @@ LS-8000 ED IEEE 1394 .ft R .RE -Please send mail to sane-devel@alioth-lists.debian.net to report successes -or failures. +Please send mail to +.I sane-devel@alioth-lists.debian.net +to report successes or failures. .SH OPTIONS The options the backend supports can either be selected through command line -options to programs like scanimage or through GUI elements in xscanimage or xsane. +options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +or +.BR xsane (1). -Valid command line options and their syntax can be listed by using +Valid command line options and their syntax can be listed by using: +.PP .RS scanimage \-\-help \-d coolscan3:<interface>:<device> .RE +.PP where <interface> and <device> specify the device in question, as in the -configuration file (see next section). The \-d parameter and its argument -can be omitted to obtain information on the first scanner identified. Use -the command +configuration file (see next section). The +.B \-d +parameter and its argument can be omitted to obtain information on the +first scanner identified. Use the command: +.PP .RS scanimage \-L .RE +.PP to list all devices recognized by your SANE installation. The options should be fully described by the description or tooltips given by frontend. Here is a description of some of the most important options, in the -syntax with which they must be supplied to scanimage: +syntax with which they must be supplied to +.BR scanimage (1): .TP -.I \-\-frame <n> +.B \-\-frame <n> This option specifies which frame to operate on, if a motorized film strip feeder or APS adapter are used. The frame number .I <n> ranges from 1 to the number of frames available, which is sensed each time the backend is initialized (usually each time you start the frontend). .TP -.I \-\-subframe <x> +.B \-\-subframe <x> This option shifts the scan window by the specified amount (default unit is mm). .TP -.I \-\-infrared=yes/no +.B \-\-infrared=yes/no 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 batch\-count=2 to obtain the -IR information. +If you use scanimage, perform a batch scan with +.B batch\-count=2 +to obtain the IR information. .TP -.I \-\-depth <n> +.B \-\-depth <n> Here <n> can either be 8 or the maximum number of bits supported by the scanner (10, 12, or 14). It specifies whether or not the scanner reduces the scanned data to 8 bits before sending it to the backend. If 8 bits are @@ -81,43 +94,45 @@ used, some information and thus image quality is lost, but the amount of data is smaller compared to higher depths. Also, many imaging programs and image formats cannot handle depths greater than 8 bits. .TP -.I \-\-autofocus +.B \-\-autofocus Perform autofocus operation. Unless otherwise specified by the other options ( -.I \-\-focus\-on\-centre +.B \-\-focus\-on\-centre and friends), focusing is performed on the centre of the selected scan area. .TP -.I \-\-ae\-wb +.B \-\-ae\-wb .TP -.I \-\-ae +.B \-\-ae Perform a pre-scan to calculate exposure values automatically. -.I \-\-ae\-wb +.B \-\-ae\-wb will maintain the white balance, while -.I \-\-ae +.B \-\-ae will adjust each channel separately. .TP -.I \-\-exposure +.B \-\-exposure Multiply all exposure times with this value. This allows exposure correction without modifying white balance. .TP -.I \-\-load +.B \-\-load Load the next slide when using the slide loader. .TP -.I \-\-eject +.B \-\-eject Eject the film strip or mounted slide when using the slide loader. .TP -.I \-\-reset +.B \-\-reset Reset scanner. The scanner will perform the same action as when power is turned on: it will eject the film strip and calibrate itself. Use this whenever the scanner refuses to load a film strip properly, as a result of which -.I \-\-eject +.B \-\-eject does not work. .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/coolscan3.conf specifies the device(s) -that the backend will use. Owing to the nature of the supported connection -types SCSI, USB, and IEEE 1394, the default configuration file supplied with -the SANE distribution should work without being edited. +The configuration file +.I @CONFIGDIR@/coolscan3.conf +specifies the device(s) that the backend will use. Owing to the nature of +the supported connection types SCSI, USB, and IEEE 1394, the default +configuration file supplied with the SANE distribution should work without +being edited. Each line in the configuration file is either of the following, where all entries are case-sensitive: @@ -157,7 +172,11 @@ a value of 128 requests all debug output to be printed. Smaller levels reduce verbosity. .SH "SEE ALSO" -sane\-scsi(5), sane\-usb(5), scanimage(1), xscanimage(1), xsane(1) +.BR sane\-scsi (5), +.BR sane\-usb (5), +.BR scanimage (1), +.BR xscanimage(1), +.BR xsane(1) .SH BUGS Currently, the SANE protocol does not allow automatically updating options @@ -177,5 +196,7 @@ about the scanner. The IEEE 1394 models therefore only work with No real bugs currently known, please report any to the SANE developers' list. .SH AUTHORS -coolscan3 written by A. Zummo (a.zummo@towertech.it), based heavily on -coolscan2 written by Andr\['a]s Major (andras@users.sourceforge.net). +coolscan3 written by A. Zummo +.RI < a.zummo@towertech.it >, +based heavily on coolscan2 written by Andr\['a]s Major +.RI < andras@users.sourceforge.net >. diff --git a/doc/sane-dc210.man b/doc/sane-dc210.man index 7d3ad65..89e9e72 100644 --- a/doc/sane-dc210.man +++ b/doc/sane-dc210.man @@ -14,22 +14,28 @@ connected. The device name is always "0". .SH CONFIGURATION The contents of the .I dc210.conf -specify the serial port and baud rate to use. The baud rate -specifies the maximum rate to use while downloading pictures. (The +specify the serial port and baud rate to use. The +.B baud +rate specifies the maximum rate to use while downloading pictures. (The camera is always initialized using 9600 baud, then switches to the higher rate). On my 90MHz Pentium, I usually have no problems downloading at 115200 baud as long as the system is not excessively busy and -the "interrupt-unmask flag" is set in the IDE driver (hdparm \-u1). +the "interrupt-unmask flag" is set in the IDE driver +.RI ( "hdparm \-u1" ). Supported baud rates are: 9600, 19200, 38400, 57600, and 115200. .PP -The dumpinquiry line causes some information about the camera to +The +.B dumpinquiry +line causes some information about the camera to be printed. .PP -cmdrespause specifies how many usec (1,000,000ths of a) between +.B cmdrespause +specifies how many usec (1,000,000ths of a) between writing the command and reading the result should be used. 125000 seems to be the lowest I could go reliably. .PP -breakpause is the time in 1,000,000ths of a usec between sending the +.B breakpause +is the time in 1,000,000ths of a usec between sending the "back to default" break sending commands. .PP Empty lines and lines starting with a hash mark (#) are @@ -71,13 +77,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@. +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config", +.IR ".", +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_DC210 If the library was compiled with debugging support enabled, this @@ -86,7 +98,7 @@ A value of 128 requests maximally copious debug output; smaller levels reduce verbosity. .SH "SEE ALSO" -sane(7) +.BR sane (7) .SH AUTHOR Brian J. Murrell @@ -102,6 +114,8 @@ Known bugs/limitations are: ? .PP More general comments, suggestions, and inquiries about frontends or SANE should go to the SANE Developers mailing list -(see http://www.sane\-project.org/mailing\-lists.html for details). +(see +.I http://www.sane\-project.org/mailing\-lists.html +for details). You must be subscribed to the list, otherwise your mail won't be sent to the subscribers. diff --git a/doc/sane-dc240.man b/doc/sane-dc240.man index 70629ab..27547c1 100644 --- a/doc/sane-dc240.man +++ b/doc/sane-dc240.man @@ -14,23 +14,28 @@ connected. The device name is always "0". .SH CONFIGURATION The contents of the .I dc240.conf -specify the serial port and baud rate to use. The baud rate -specifies the maximum rate to use while downloading pictures. (The +specify the serial port and baud rate to use. The +.B baud +rate specifies the maximum rate to use while downloading pictures. (The camera is always initialized using 9600 baud, then switches to the higher rate). On a 450MHz Pentium, I usually have no problems downloading at 115200 baud, though the camera sometimes has to resend packets due to lost characters. Results are better when -the "interrupt-unmask flag" is set in the IDE driver (hdparm \-u1). +the "interrupt-unmask flag" is set in the IDE driver +.RI ( "hdparm \-u1" ). Supported baud rates are: 9600, 19200, 38400, 57600, and 115200. .PP -The dumpinquiry line causes some information about the camera to -be printed. +The +.B dumpinquiry +line causes some information about the camera to be printed. .PP -cmdrespause specifies how many usec (1,000,000ths of a) between +.B cmdrespause +specifies how many usec (1,000,000ths of a) between writing the command and reading the result should be used. 125000 seems to be the lowest I could go reliably. .PP -breakpause is the time in 1,000,000ths of a usec between sending the +.B breakpause +is the time in 1,000,000ths of a usec between sending the "back to default" break sending commands. .PP Empty lines and lines starting with a hash mark (#) are @@ -72,13 +77,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.I @CONFIGDIR@. +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config", +.IR ".", +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_DC240 If the library was compiled with debugging support enabled, this @@ -87,7 +98,7 @@ A value of 128 requests maximally copious debug output; smaller levels reduce verbosity. .SH "SEE ALSO" -sane(7) +.BR sane (7) .SH AUTHOR Peter S. Fales @@ -107,6 +118,8 @@ actually be found in multiple directories. .PP More general comments, suggestions, and inquiries about frontends or SANE should go to the SANE Developers mailing list -(see http://www.sane\-project.org/mailing\-lists.html for details). +(see +.I http://www.sane\-project.org/mailing\-lists.html +for details). You must be subscribed to the list, otherwise your mail won't be sent to the subscribers. diff --git a/doc/sane-dc25.man b/doc/sane-dc25.man index 889fd2d..23f4717 100644 --- a/doc/sane-dc25.man +++ b/doc/sane-dc25.man @@ -20,7 +20,8 @@ specifies the maximum rate to use while downloading pictures. (The camera is always initialized using 9600 baud, then switches to the higher rate). On my 90MHz Pentium, I usually have no problems downloading at 115200 baud as long as the system is not excessively busy and -the "interrupt-unmask flag" is set in the IDE driver (hdparm \-u1). +the "interrupt-unmask flag" is set in the IDE driver +.RI ( "hdparm \-u1" ). Supported baud rates are: 9600, 19200, 38400, 57600, and 115200. .PP The dumpinquiry line causes some information about the camera to @@ -64,13 +65,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_DC25 If the library was compiled with debugging support enabled, this @@ -79,10 +86,11 @@ A value of 128 requests maximally copious debug output; smaller levels reduce verbosity. .SH "SEE ALSO" -sane(7) +.BR sane (7) .SH AUTHOR -Peter Fales, dc25\-devel@fales\-lorenz.net +Peter Fales, +.IR dc25\-devel@fales\-lorenz.net . .SH BUGS Known bugs/limitations are: @@ -94,6 +102,8 @@ updated immediately. .PP More general comments, suggestions, and inquiries about frontends or SANE should go to the SANE Developers mailing list -(see http://www.sane\-project.org/mailing\-lists.html for details). +(see +.I http://www.sane\-project.org/mailing\-lists.html +for details). You must be subscribed to the list, otherwise your mail won't be sent to the subscribers. diff --git a/doc/sane-dll.man b/doc/sane-dll.man index e93f897..aaa3577 100644 --- a/doc/sane-dll.man +++ b/doc/sane-dll.man @@ -140,13 +140,18 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the -environment variable ends with the directory separator character, then -the default directories are searched after the explicitly specified -directories. For example, setting +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory +separator character, then the default directories are searched after +the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_DLL If the library was compiled with debug support enabled, this diff --git a/doc/sane-dmc.man b/doc/sane-dmc.man index 1aba8f8..a076736 100644 --- a/doc/sane-dmc.man +++ b/doc/sane-dmc.man @@ -49,8 +49,13 @@ 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. (xcam and the -non-preview modes of scanimage and xscanimage work fine, however.) +of xscanimage does not work in Super Resolution mode. +.RB ( xcam (1) +and the non-preview modes of +.BR scanimage (1) +and +.BR xscanimage (1) +work fine, however.) .PP .SH OTHER SETTINGS .TP @@ -101,13 +106,18 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the -environment variable ends with the directory separator character, then -the default directories are searched after the explicitly specified -directories. For example, setting +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator +character, then the default directories are searched after the explicitly +specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config", +.IR ".", +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_DMC If the library was compiled with debug support enabled, this @@ -122,7 +132,7 @@ may read less than you ask for. If you ask sane_read to read less than a single line, it returns SANE_STATUS_INVAL. .PP In the "Super Resolution" mode, images must be read in units of -\fItwo\fR lines (3198 pixels or 9594 bytes.) If you try to read less +\fItwo\fR lines (3198 pixels or 9594 bytes). If you try to read less than two lines, you get SANE_STATUS_INVAL. The Super Resolution mode is very slow. .PP @@ -130,11 +140,14 @@ In the "Viewfinder" and "Thumbnail" modes, the entire image must be read in one SCSI transfer. In this case, the driver performs buffering and you can read the image in as small an increment as you like. + .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5) + .SH AUTHOR David F. Skoll .PP The backend is derived from -.BR sane\-hp +.BR sane\-hp (5) by David Mosberger diff --git a/doc/sane-epjitsu.man b/doc/sane-epjitsu.man index 9a31da2..25b9a46 100644 --- a/doc/sane-epjitsu.man +++ b/doc/sane-epjitsu.man @@ -7,42 +7,56 @@ sane\-epjitsu \- SANE backend for Epson-based Fujitsu USB scanners. .SH DESCRIPTION The .B sane\-epjitsu -library implements a SANE (Scanner Access Now Easy) backend which provides basic access the Fujitsu fi\-60F/fi\-65F and ScanSnap S300/S1300(i)/S1100(i) scanners. +library implements a SANE (Scanner Access Now Easy) backend which provides basic access the +Fujitsu fi\-60F/fi\-65F and ScanSnap S300/S1300(i)/S1100(i) scanners. .SH HARDWARE SUPPORT -These scanners are fairly limited, only supporting a couple of modes and resolutions, and always scanning full width. The backend supports missing modes (binary, grayscale) and intermediate resolutions in software, but provides only minimal scan area controls. See +These scanners are fairly limited, only supporting a couple of modes and resolutions, and +always scanning full width. The backend supports missing modes (binary, grayscale) and +intermediate resolutions in software, but provides only minimal scan area controls. See .B KNOWN ISSUES. -This backend may support other scanners. If physical inspection reveals an Epson chipset, please contact the author for instructions on collecting a USB trace under Windows to verify. +This backend may support other scanners. If physical inspection reveals an Epson chipset, +please contact the author for instructions on collecting a USB trace under Windows to verify. .SH OPTIONS -A limited effort has been made to expose the standard options to the API. This allows a frontend to set resolution, color mode, and choose the ADF setting. The epjitsu backend supports the following basic options for most scanners: +A limited effort has been made to expose the standard options to the API. This allows a +frontend to set resolution, color mode, and choose the ADF setting. The +.B sane\-epjitsu +backend supports the following basic options for most scanners: .PP -source s +.BR source s .RS Selects the source for the scan. Options may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex". .RE .PP -mode m +.BR mode m .RS Selects the mode for the scan. Options may include "Lineart", "Gray", "Color". .RE .PP -resolution, y\-resolution +.BR resolution , y\-resolution .RS -Controls scan resolution. Setting \-\-resolution also sets \-\-y\-resolution, though this behavior is overridden by some frontends. +Controls scan resolution. Setting +.B \-\-resolution +also sets +.B \-\-y\-resolution, though this behavior is overridden by some frontends. .RE .PP -Other options will be available based on the capabilities of the scanner. Use 'scanimage \-\-help' to get a list. Be aware that some options may appear only when another option has been set, and that advanced options may be hidden by the frontend. +Other options will be available based on the capabilities of the scanner. Use +.I 'scanimage \-\-help' +to get a list. Be aware that some options may appear only when another option has been set, and that advanced options may be hidden by the frontend. .PP .SH CONFIGURATION FILE -The configuration file "@CONFIGDIR@/epjitsu.conf" is used to tell the backend how to look for scanners, and provide options controlling the operation of the backend. This file is read each time the frontend asks the backend for a list of scanners, generally only when the frontend starts. If the configuration file is missing, the backend will not work. +The configuration file +.I "@CONFIGDIR@/epjitsu.conf" +is used to tell the backend how to look for scanners, and provide options controlling the operation of the backend. This file is read each time the frontend asks the backend for a list of scanners, generally only when the frontend starts. If the configuration file is missing, the backend will not work. .PP Scanners can be specified in the configuration file in two ways: .PP "usb 0x04c5 0x10c7" (or other vendor/product ids) .RS -Requests backend to search all usb busses 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 supported scanner. +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 supported scanner. .RE .PP "usb /dev/usb/scanner0" (or other device file) @@ -63,7 +77,9 @@ This option may appear multiple times in the configuration file. It only applies .PP .SH ENVIRONMENT -The backend uses a single environment variable, SANE_DEBUG_EPJITSU, which enables debugging output to stderr. Valid values are: +The backend uses a single environment variable, +.BR SANE_DEBUG_EPJITSU, +which enables debugging output to stderr. Valid values are: .PP .RS 5 Errors @@ -98,8 +114,10 @@ fi\-60F support funded by TrueCheck, Inc. Improved calibration code provided by Richard Goedeken. .SH "SEE ALSO" -sane(7), -sane\-usb(5) +.BR sane (7), +.BR sane\-usb (5) +.BR scanimage (1) .SH AUTHOR -m. allan noah: <kitno455 a t gmail d o t com> +m. allan noah: +.RI < "kitno455 a t gmail d o t com" > diff --git a/doc/sane-epson.man b/doc/sane-epson.man index f09f075..75ffad3 100644 --- a/doc/sane-epson.man +++ b/doc/sane-epson.man @@ -5,7 +5,7 @@ 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 @@ -49,22 +49,30 @@ and many more. The official list is on the Sane web site. .RE For other scanners the software may or may not work. Please send mail to -the backend author (khk@khk.net) to report success with scanners not on -the list or problems with scanners that are listed. +the backend author +.RI ( khk@khk.net ) +to report success with scanners not on the list or problems with scanners +that are listed. .SH OPTIONS The options the backend supports can either be selected through command line -options to programs like scanimage or through GUI elements in programs like -xscanimage or xsane. - -Valid command line options and their syntax can be listed by using +options to programs like +.BR scanimage (1) +or through GUI elements in programs like +.BR xscanimage (1) +or +.BR xsane (1). + +Valid command line options and their syntax can be listed by using: +.PP .RS scanimage \-\-help \-d epson .RE +.PP Not all devices support all options. .TP .I Scan Mode The -.I \-\-mode +.B \-\-mode switch selects the basic mode of operation of the scanner. Valid choices are Binary, Gray and Color. The Binary mode is black and white only, Gray will produce 256 levels of gray or more depending on the scanner @@ -73,7 +81,7 @@ Some scanners will internally use 36 bit color, their external interface however may only support 24 bits. The -.I \-\-depth +.B \-\-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 @@ -82,7 +90,7 @@ 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 \-\-halftoning +.B \-\-halftoning switch selects the mode that is used in Binary mode. Valid options are "None", "Halftone A (Hard Tone)", "Halftone B (Soft Tone)", "Halftone C (Net Screen)", "Dither A (4x4 Bayer)", "Dither B (4x4 Spiral)", "Dither C @@ -90,129 +98,136 @@ are "None", "Halftone A (Hard Tone)", "Halftone B (Soft Tone)", "Halftone C "Download pattern A", and "Download pattern B". The -.I \-\-dropout +.B \-\-dropout switch selects the so called dropout color. Valid options are None, Red, Green and Blue. The default is None. The dropout color is used for monochrome scanning and selects the color that is not scanned. This can be used to e.g. scan an original with a colored background. The -.I \-\-brightness +.B \-\-brightness switch controls the brightness of the scan. Valid options are integer values from \-3 to 3. The default is 0. The larger the brightness value, the brighter the image gets. If a user defined table for the gamma correction is selected, the brightness parameter is not available. The -.I \-\-sharpness +.B \-\-sharpness switch sets the sharpness of the image data. Valid options are integer values from \-2 to 2, with \-2 meaning "Defocus", \-1 "Defocus slightly", 0 "Normal", 1 "Sharpen slightly" and 2 "Sharpen". The -.I \-\-gamma\-correction +.B \-\-gamma\-correction switch controls the scanner's internal gamma correction. Valid options are "Default", "User defined", "High density printing" "Low density printing" and "High contrast printing". The -.I \-\-color\-correction +.B \-\-color\-correction switch controls the scanner's internal color correction function. Valid options are "No Correction", "Impact\-dot printers", "Thermal printers", "Ink\-jet printers" and "CRT monitors". The default is "CRT monitors". The -.I \-\-resolution +.B \-\-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. +parameters to +.BR scanimage (1). The -.I \-\-mirror +.B \-\-mirror option controls the way the image is scanned. By reading the image data from right to left the image is mirrored. Valid options are "yes" and "no". The default is "no". The -.I \-\-speed +.B \-\-speed option can improve the scan speed in monochrome mode. Valid options are "yes" or "no", the "yes" option will speed up the scan if this option is supported. The -.I \-\-auto\-area\-segmentation +.B \-\-auto\-area\-segmentation switch activates the automatic area segmentation for monochrome scans. The scanner will try to determine which areas are text and which contain images. The image areas will be halftoned, and the text will be improved. Valid options are "yes" and "no". The default is "yes". The -.I \-\-gamma\-table +.B \-\-gamma\-table parameter can be used to download a user defined gamma table. The option takes 256 values from the range 0-255. In color mode this option equally affects the red, green, and blue channel. The -.I \-\-red\-gamma\-table +.B \-\-red\-gamma\-table parameter can be used to download a user defined gamma table for the red channel. The valid options are the same as for \-\-gamma\-table. The -.I \-\-green\-gamma\-table +.B \-\-green\-gamma\-table parameter can be used to download a user defined gamma table for the green channel. The valid options are the same as for \-\-gamma\-table. The -.I \-\-blue\-gamma\-table +.B \-\-blue\-gamma\-table parameter can be used to download a user defined gamma table for the blue channel. The valid options are the same as for \-\-gamma\-table. The color correction coefficients -.I \-\-cct\-1 \-\-cct\-2 \-\-cct\-3 ... \-\-cct\-9 +.B \-\-cct\-1 \-\-cct\-2 \-\-cct\-3 ... \-\-cct\-9 will install color correction coefficients for the user defined color correction. Values are specified as integers in the range \-127..127. The -.I \-\-preview +.B \-\-preview option requests a preview scan. The frontend software automatically selects a low resolution. Valid options are "yes" and "no". The default is "no". The -.I \-\-preview\-speed +.B \-\-preview\-speed options will increase the scan speed if this is supported by the scanner. Valid options are "yes" and "no", the default is "no". 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. +.B \-l \-t \-x \-y +control the scan area: +.B \-l +sets the top left x coordinate, +.B \-t +the top left y coordinate, +.B \-x +selects the width and +.B \-y +the height of the scan area. All parameters are specified in millimeters. The -.I \-\-quick\-format +.B \-\-quick\-format option lets the user select a scan area with predefined sizes. Valid parameters are "CD", "A5 portrait", "A5 landscape", "Letter", "A4" and "max". The default is "max", which selects the largest possible area. The -.I \-\-source +.B \-\-source option selects the scan source. Valid options depend on the installed options. The default is "Flatbed". The -.I \-\-auto\-eject +.B \-\-auto\-eject option will eject a page after scanning from the document feeder. The -.I \-\-film\-type +.B \-\-film\-type option will select the film type for scans with the transparency unit. This option is only activated if the TPU is selected as scan source. Valid options are "Negative Film" and "Positive Film". The -.I \-\-focus\-position +.B \-\-focus\-position option selects the focus position for all scans. Valid options are "Focus 2.5mm above glass" and "Focus on glass". The focus on the 2.5mm point above the glass is necessary for scans with the transparency unit, so @@ -222,13 +237,15 @@ will ignore this option. .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/epson.conf specifies the device(s) that the -backend will use. Possible connection types are: +The configuration file +.I @CONFIGDIR@/epson.conf +specifies the device(s) that the backend will use. Possible connection types are: .TP .I SCSI This is the default, and if nothing else is specified the backend software will open a given path as SCSI device. More information about valid syntax for SCSI -devices can be found in sane\-scsi(5). +devices can be found in +.BR sane\-scsi (5). .br Usually SCSI scanners are configured with a line "scsi EPSON" in this file. In some cases it may be necessary to only use the string "scsi" (e.g. for the GT-6500). @@ -279,7 +296,10 @@ only if you know what you are doing! .SH "SEE ALSO" -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1) +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1) .SH BUGS @@ -302,5 +322,6 @@ Perfection 1260 are not supported by this backend. .SH AUTHOR -The package is actively maintained by Karl Heinz Kremer (khk@khk.net). The -software is based on work by Christian Bucher and Kazuhiro Sasayama +The package is actively maintained by Karl Heinz Kremer +.RI ( khk@khk.net ). +The software is based on work by Christian Bucher and Kazuhiro Sasayama. diff --git a/doc/sane-epson2.man b/doc/sane-epson2.man index 33acd78..6c6b9a3 100644 --- a/doc/sane-epson2.man +++ b/doc/sane-epson2.man @@ -99,18 +99,24 @@ the sane-backend mailing list to report success with scanners not on the list or problems with scanners that are listed. .SH OPTIONS The options the backend supports can either be selected through command line -options to programs like scanimage or through GUI elements in programs like -xscanimage or xsane. +options to programs like +.BR scanimage (1) +or through GUI elements in programs like +.BR xscanimage (1) +or +.BR xsane (1). Valid command line options and their syntax can be listed by using +.PP .RS scanimage \-\-help \-d epson2 .RE +.PP Not all devices support all options. .TP .I Scan Mode The -.I \-\-mode +.B \-\-mode switch selects the basic mode of operation of the scanner. Valid choices are Binary, Gray and Color. The Binary mode is black and white only, Gray will produce 256 levels of gray or more depending on the scanner @@ -119,7 +125,7 @@ Some scanners will internally use 36 bit color, their external interface however may only support 24 bits. The -.I \-\-depth +.B \-\-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 @@ -128,7 +134,7 @@ 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 \-\-halftoning +.B \-\-halftoning switch selects the mode that is used in Binary mode. Valid options are "None", "Halftone A (Hard Tone)", "Halftone B (Soft Tone)", "Halftone C (Net Screen)", "Dither A (4x4 Bayer)", "Dither B (4x4 Spiral)", "Dither C @@ -136,114 +142,121 @@ are "None", "Halftone A (Hard Tone)", "Halftone B (Soft Tone)", "Halftone C "Download pattern A", and "Download pattern B". The -.I \-\-dropout +.B \-\-dropout switch selects the so called dropout color. Valid options are None, Red, Green and Blue. The default is None. The dropout color is used for monochrome scanning and selects the color that is not scanned. This can be used to e.g. scan an original with a colored background. The -.I \-\-brightness +.B \-\-brightness switch controls the brightness of the scan. Valid options are integer values from \-3 to 3. The default is 0. The larger the brightness value, the brighter the image gets. If a user defined table for the gamma correction is selected, the brightness parameter is not available. The -.I \-\-sharpness +.B \-\-sharpness switch sets the sharpness of the image data. Valid options are integer values from \-2 to 2, with \-2 meaning "Defocus", \-1 "Defocus slightly", 0 "Normal", 1 "Sharpen slightly" and 2 "Sharpen". The -.I \-\-gamma\-correction +.B \-\-gamma\-correction switch controls the scanner's internal gamma correction. Valid options are "Default", "User defined", "High density printing" "Low density printing" and "High contrast printing". The -.I \-\-color\-correction +.B \-\-color\-correction switch controls the scanner's internal color correction function. Valid options are "No Correction", "Impact\-dot printers", "Thermal printers", "Ink\-jet printers" and "CRT monitors". The default is "CRT monitors". The -.I \-\-resolution +.B \-\-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. +parameters to +.BR scanimage (1). The -.I \-\-threshold +.B \-\-threshold switch selects the minimum brightness to get a white point. The -.I \-\-mirror +.B \-\-mirror option controls the way the image is scanned. By reading the image data from right to left the image is mirrored. Valid options are "yes" and "no". The default is "no". The -.I \-\-auto\-area\-segmentation +.B \-\-auto\-area\-segmentation switch activates the automatic area segmentation for monochrome scans. The scanner will try to determine which areas are text and which contain images. The image areas will be halftoned, and the text will be improved. Valid options are "yes" and "no". The default is "yes". The -.I \-\-red\-gamma\-table +.B \-\-red\-gamma\-table parameter can be used to download a user defined gamma table for the red channel. The valid options are the same as for \-\-gamma\-table. The -.I \-\-green\-gamma\-table +.B \-\-green\-gamma\-table parameter can be used to download a user defined gamma table for the green channel. The valid options are the same as for \-\-gamma\-table. The -.I \-\-blue\-gamma\-table +.B \-\-blue\-gamma\-table parameter can be used to download a user defined gamma table for the blue channel. The valid options are the same as for \-\-gamma\-table. The -.I --wait-for-button +.B --wait-for-button parameter can be used to wait until the button on the scanner is pressed to actually start the scan process. The color correction coefficients -.I \-\-cct\-1 \-\-cct\-2 \-\-cct\-3 ... \-\-cct\-9 +.B \-\-cct\-1 \-\-cct\-2 \-\-cct\-3 ... \-\-cct\-9 will install color correction coefficients for the user defined color correction. Values are specified as integers in the range \-127..127. The -.I \-\-preview +.B \-\-preview option requests a preview scan. The frontend software automatically selects a low resolution. Valid options are "yes" and "no". The default is "no". 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. +.B \-l \-t \-x \-y +control the scan area: +.B \-l +sets the top left x coordinate, +.BR \-t +the top left y coordinate, +.BR \-x +selects the width and +.BR \-y +the height of the scan area. All parameters are specified in millimeters. The -.I \-\-source +.B \-\-source option selects the scan source. Valid options depend on the installed options. The default is "Flatbed". The -.I \-\-auto\-eject +.B \-\-auto\-eject option will eject a page after scanning from the document feeder. The -.I \-\-film\-type +.B \-\-film\-type option will select the film type for scans with the transparency unit. This option is only activated if the TPU is selected as scan source. Valid options are "Negative Film" and "Positive Film". The -.I \-\-focus\-position +.B \-\-focus\-position option selects the focus position for all scans. Valid options are "Focus 2.5mm above glass" and "Focus on glass". The focus on the 2.5mm point above the glass is necessary for scans with the transparency unit, so @@ -252,48 +265,53 @@ This option is only functional for selected scanners, all other scanners will ignore this option. The -.I \-\-bay +.B \-\-bay option selects which bay to scan The -.I \-\-eject +.B \-\-eject option ejects the sheet in the ADF. The -.I \-\-adf-mode +.B \-\-adf-mode option select the ADF mode (simplex/duplex). .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/epson2.conf specifies the device(s) that the +The configuration file +.I @CONFIGDIR@/epson2.conf +specifies the device(s) that the backend will use. Possible connection types are: .TP -.I SCSI +.B SCSI This is the default, and if nothing else is specified the backend software will open a given path as SCSI device. More information about valid syntax for SCSI -devices can be found in sane\-scsi(5). +devices can be found in +.BR sane\-scsi (5). .br Usually SCSI scanners are configured with a line "scsi EPSON" in this file. In some cases it may be necessary to only use the string "scsi" (e.g. for the GT-6500). .TP -.I PIO \- Parallel Interface +.B PIO \- Parallel Interface 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 +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 +.B USB For USB scanners not automatically detect, 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). +More information about valid syntax for USB devices can be found in +.BR sane\-usb (5). .TP -.I Network +.B Network Network scanners can be auto-discovered if -.I autodiscovery +.B autodiscovery is specified after -.I -net +.B net keyword. An IP address to connect to can also be used. .SH FILES .TP @@ -333,7 +351,11 @@ only if you know what you are doing! .SH "SEE ALSO" -sane\-scsi(5), sane\-usb(5), scanimage(1), xscanimage(1), xsane(1) +.BR sane\-scsi (5), +.BR sane\-usb (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1) .SH BUGS @@ -355,4 +377,4 @@ AUTHORS file of the SANE distribution). The package is written by Alessandro Zummo and is based on previous work done by Karl Hienz Kremer in the epson package as well as based -on work by Christian Bucher and Kazuhiro Sasayama +on work by Christian Bucher and Kazuhiro Sasayama. diff --git a/doc/sane-epsonds.man b/doc/sane-epsonds.man index 03bbbd2..a7c9e32 100644 --- a/doc/sane-epsonds.man +++ b/doc/sane-epsonds.man @@ -5,18 +5,20 @@ 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. +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 +.PP .RS scanimage \-\-help \-d epsonds .RE +.PP Not all devices support all options. .TP .I Scan Mode The -.I \-\-mode +.B \-\-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 @@ -25,7 +27,7 @@ Some scanners will internally use 36 bit color, their external interface however may only support 24 bits. The -.I \-\-depth +.B \-\-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 @@ -34,46 +36,54 @@ 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 +.B \-\-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. +parameters to +.BR scanimage (1). 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. +.B \-l \-t \-x \-y +control the scan area: +.B \-l +sets the top left x coordinate, +.B \-t +the top left y coordinate, +.B \-x +selects the width and +.B \-y +the height of the scan area. All parameters are specified in millimeters. The -.I \-\-source +.B \-\-source option selects the scan source. Valid options depend on the installed options. The default is "Flatbed". The -.I \-\-eject +.B \-\-eject option ejects the sheet in the ADF. The -.I \-\-adf-mode +.B \-\-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: +The configuration file +.I @CONFIGDIR@/epsonds.conf +specifies the device(s) that the backend will use. Possible connection types are: .TP -.I USB +.B 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). +More information about valid syntax for USB devices can be found in +.BR sane\-usb (5). .TP -.I Network (not yet supported) +.B Network (not yet supported) Network scanners can be auto-discovered if -.I autodiscovery +.B autodiscovery is specified after -.I -net +.B net keyword. An IP address to connect to can also be used. .SH FILES .TP @@ -89,12 +99,15 @@ support dynamic loading). 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 +levels reduce verbosity. Values around 11-16 will usually be enough for a bug report. .SH "SEE ALSO" -sane\-usb(5), scanimage(1), xscanimage(1), xsane(1) +.BR sane\-usb (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1) .SH AUTHOR diff --git a/doc/sane-escl.man b/doc/sane-escl.man index a737684..92a6650 100644 --- a/doc/sane-escl.man +++ b/doc/sane-escl.man @@ -5,34 +5,44 @@ sane\-escl \- SANE backend for eSCL scanners .SH DESCRIPTION The .B sane\-escl -library implements a SANE (Scanner Access Now Easy) backend that -provides access to eSCL protocol scanners. +library implements a SANE (Scanner Access Now Easy) backend that provides access to +eSCL protocol scanners. .PP Currently, the following models work with this backend (This list is not exhaustive): .PP .RS BROTHER DCP-L2530 .br +BROTHER HL-L2590DW +.br CANON IR C3520 .br +CANON PIXMA MG5765 +.br CANON PIXMA TS3100, TS3150, TS3300, TS3151, TS3350, TS3351, .br -CANON PIXMA TS3352, TS6150, TS8050, TS9100, TR4540, TR8500, +CANON PIXMA TS3352, TS5351, TS6150, TS8050, TS9100, TR4540, .br -CANON PIXMA TR8520 +CANON PIXMA TR8500, TR8520 .br EPSON ET3740, ET4750 .br -HP LASERJET MFP M28W, OFFICEJET 4630, OFFICEJET PRO 8610 +HP DESKJET 2710, DESKJET 2723, DESKJET 3760, LASERJET MFP M28W, +.br +HP OFFICEJET 4630, OFFICEJET PRO 8610 .br RICOH SP3710S .br XEROX VERSALINK C7220 .RE .PP -The "escl" backend for SANE supports AirScan/eSCL devices that announce +The. +.B sane\-escl +backend for SANE supports AirScan/eSCL devices that announce themselves on mDNS as _uscan._utcp or _uscans._utcp. -If the device is available, the "escl" backend recovers these capacities. +If the device is available, the +.B sane\-escl +backend recovers these capacities. The user configures and starts scanning. A list of devices that use the eSCL protocol can be found at .IR https://support.apple.com/en-us/HT201311 . @@ -49,6 +59,7 @@ The static library implementing this backend. .I @LIBDIR@/libsane\-escl.so The shared library implementing this backend (present on systems that support dynamic loading). + .SH ENVIRONMENT .TP .B SANE_DEBUG_ESCL @@ -56,7 +67,12 @@ 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. + .SH "SEE ALSO" -sane(7), scanimage(1), xscanimage(1), xsane(1) +.BR sane (7) +.BR scanimage (1) +.BR xscanimage (1) +.BR xsane (1) + .SH AUTHORS Touboul Nathane, Thierry HUCHARD diff --git a/doc/sane-find-scanner.man b/doc/sane-find-scanner.man index 26c5258..ae46369 100644 --- a/doc/sane-find-scanner.man +++ b/doc/sane-find-scanner.man @@ -15,7 +15,7 @@ sane\-find\-scanner \- find SCSI and USB scanners and their device files .SH DESCRIPTION .B sane\-find\-scanner -is a command-line tool to find SCSI and USB scanners and determine their Unix +is a command-line tool to find SCSI and USB scanners and determine their UNIX device files. Its primary aim is to make sure that scanners can be detected by SANE backends. .PP @@ -59,7 +59,7 @@ won't find most parallel port scanners, or scanners connected to proprietary ports. Some .B parallel port scanners may be detected by -.B sane\-find\-scanner -p. +.I sane\-find\-scanner -p. At the time of writing this will only detect Mustek parallel port scanners. .SH OPTIONS @@ -90,22 +90,23 @@ filename is a file that contains USB descriptors in the format of /proc/bus/usb/devices as used by Linux. .B sane\-find\-scanner tries to identify the chipset(s) of all USB scanners found in such a file. This -option is useful for developers when the output of "cat /proc/bus/usb/devices" +option is useful for developers when the output of +.I "cat /proc/bus/usb/devices" is available but the scanner itself isn't. .TP 8 .B devname Test device file "devname". No other devices are checked if devname is given. .SH EXAMPLE -.B sane\-find\-scanner \-v +.I sane\-find\-scanner \-v .br Check all SCSI and USB devices for available scanners and print a line for every device file. .PP -.B sane\-find\-scanner /dev/scanner +.I sane\-find\-scanner /dev/scanner .br Look for a (SCSI) scanner only at /dev/scanner and print the result. .PP -.B sane\-find\-scanner \-p +.I sane\-find\-scanner \-p .br Probe for parallel port scanners. .SH "SEE ALSO" diff --git a/doc/sane-fujitsu.man b/doc/sane-fujitsu.man index 400a35e..161347f 100644 --- a/doc/sane-fujitsu.man +++ b/doc/sane-fujitsu.man @@ -7,8 +7,8 @@ sane\-fujitsu \- SANE backend for Fujitsu flatbed and ADF 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. +library implements a SANE (Scanner Access Now Easy) backend which provides +access to most Fujitsu flatbed and ADF scanners. This document describes backend version 136, which shipped with SANE 1.0.30. @@ -17,7 +17,8 @@ This version supports every known model which speaks the Fujitsu SCSI and SCSI\-over\-USB protocols. Specifically, the SCSI M309x and M409x series, the SCSI fi\-series, most of the USB fi\-series, the USB ScanSnap S5xx/S15xx, and the USB iX1xx/5xx series scanners are supported. Please see the list at -http://www.sane\-project.org/sane\-supported\-devices.html for details. +.I http://www.sane\-project.org/sane\-supported\-devices.html +for details. This backend may support other Fujitsu scanners. The best way to determine level of support is to test the scanner directly, @@ -51,31 +52,35 @@ SP\-600C/620C fi\-5015C .SH OPTIONS Effort has been made to expose all hardware options, including: .PP -source s +.B source s .RS Selects the source for the scan. Options may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex", "Card Front", "Card Back", "Card Duplex". .RE .PP -mode m +.B mode m .RS Selects the mode for the scan. Options may include "Lineart", "Halftone", "Gray", and "Color". .RE .PP -resolution, y\-resolution +.B resolution, y\-resolution .RS -Controls scan resolution. Setting \-\-resolution also sets \-\-y\-resolution, +Controls scan resolution. Setting +.B \-\-resolution +also sets +.BR \-\-y\-resolution, though this behavior is overridden by some frontends. .RE .PP -tl\-x, tl\-y, br\-x, br\-y +.B tl\-x, tl\-y, br\-x, br\-y .RS Sets scan area upper left and lower right coordinates. These are renamed -t, l, x, y by some frontends. +.B t, l, x, y +by some frontends. .RE .PP -page\-width, page\-height +.B page\-width, page\-height .RS Sets paper size. Used by scanner to determine centering of scan coordinates when using ADF and to detect double feed errors. @@ -94,12 +99,16 @@ may not perform as well as the native implementations. Note also that these features all require that the driver cache the entire image in memory. This will almost certainly result in a reduction of scanning speed. -Use 'scanimage \-\-help' to get a list, but be aware that some options may +Use +.I 'scanimage \-\-help' +to get a list, but be aware that some options may be settable only when another option has been set, and that advanced options may be hidden by some frontend programs. -.PP + .SH CONFIGURATION FILE -The configuration file "fujitsu.conf" is used to tell the backend how to look +The configuration file +.I fujitsu.conf +is used to tell the backend how to look for scanners, and provide options controlling the operation of the backend. This file is read each time the frontend asks the backend for a list of scanners, generally only when the frontend starts. If the configuration @@ -109,7 +118,7 @@ Scanners can be specified in the configuration file in 4 ways: .PP "scsi FUJITSU" .RS -Requests backend to search all scsi busses in the system for a device +Requests backend to search all scsi buses in the system for a device which reports itself to be a scanner made by 'FUJITSU'. .RE .PP @@ -122,7 +131,7 @@ specify one. Probably should not be used with the other "scsi" line above. .PP "usb 0x04c5 0x1042" (or other vendor/product ids) .RS -Requests backend to search all usb busses in the system for a device +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. .RE @@ -149,8 +158,9 @@ warned. .PP .SH ENVIRONMENT -The backend uses a single environment variable, SANE_DEBUG_FUJITSU, which -enables debugging output to stderr. Valid values are: +The backend uses a single environment variable, +.BR SANE_DEBUG_FUJITSU , +which enables debugging output to stderr. Valid values are: .PP .RS 5 Errors @@ -183,26 +193,32 @@ JPEG output is supported by the backend, but not by the SANE protocol, so is disabled in this release. It can be enabled if you rebuild from source. .SH CREDITS -m3091 backend: Frederik Ramm <frederik a t remote d o t org> +m3091 backend: Frederik Ramm +.RI < "frederik a t remote d o t org" > .br -m3096g backend: Randolph Bentson <bentson a t holmsjoen d o t com> +m3096g backend: Randolph Bentson +.RI < "bentson a t holmsjoen d o t com" > .br (with credit to the unnamed author of the coolscan driver) .br fujitsu backend, m3093, fi\-4340C, ipc, cmp, long\-time maintainer: .br - Oliver Schirrmeister <oschirr a t abm d o t de> + Oliver Schirrmeister +.RI < "oschirr a t abm d o t de" > .br -m3092: Mario Goppold <mgoppold a t tbzpariv d o t tcc\-chemnitz dot de> +m3092: Mario Goppold +.RI < "mgoppold a t tbzpariv d o t tcc\-chemnitz dot de" > .br -fi\-4220C and basic USB support: Ron Cemer <ron a t roncemer d o t com> +fi\-4220C and basic USB support: Ron Cemer +.RI < "ron a t roncemer d o t com" > .br fi\-4120, fi\-series color, backend re\-write, jpeg, current maintainer: - m. allan noah: <kitno455 a t gmail d o t com> + m. allan noah: +.RI < "kitno455 a t gmail d o t com" > JPEG output and low memory usage support funded by: Archivista GmbH - www.archivista.ch +.I www.archivista.ch Endorser support funded by: O A S Oilfield Accounting Service Ltd @@ -210,27 +226,27 @@ Endorser support funded by: Calgary, Alberta T2P 3G2 Canada 1\-403\-263\-2600 - www.oas.ca +.I www.oas.ca Automatic length detection support funded by: Martin G. Miller - mgmiller at optonline.net +.I mgmiller at optonline.net Hardware donated, software image enhancement and fi-6/7xxx support funded by: Fujitsu Computer Products of America, Inc. - www.fcpa.com +.I www.fcpa.com iX500 support funded by: Prefix Computer Services - www.prefixservice.com +.I www.prefixservice.com .SH "SEE ALSO" -sane(7), -sane\-scsi(5), -sane\-usb(5), -sane\-sp15c(5), -sane\-avision(5), -sane\-epjitsu(5) +.BR sane (7), +.BR sane\-scsi (5), +.BR sane\-usb (5), +.BR sane\-sp15c (5), +.BR sane\-avision (5), +.BR sane\-epjitsu (5) .SH AUTHOR m. allan noah: <kitno455 a t gmail d o t com> diff --git a/doc/sane-genesys.man b/doc/sane-genesys.man index 837a5f6..cf4fa38 100644 --- a/doc/sane-genesys.man +++ b/doc/sane-genesys.man @@ -54,7 +54,12 @@ frontend. The result of the calibration is stored in a file in the home director If you plug the scanner in another machine or use it with another account, calibration will have to be redone, unless you use the \-\-calibration\-file option. If no home directory is defined, -USERAPPPROFILE will be used, then TMPDIR or TMP. If none of these directories exist, the backend will try +.B USERAPPPROFILE +will be used, then +.B TMPDIR +or +.BR TMP. +If none of these directories exist, the backend will try to write in the current working directory. Flatbed scanners also make use of the calibration file as a cache to avoid calibration before each scan. Calibration file name is the name of the scanner model if only one scanner is detected. In the case of several identical model, the file name will be the name @@ -63,73 +68,62 @@ A value of -1 means forever, 0 means no cache. .SH EXTRAS SCAN OPTIONS +.TP .B \-\-lamp\-off\-time number -.RS - The lamp will be turned off after the given time (in minutes). A value of 0 means that the lamp won't be turned off. -.RE +The lamp will be turned off after the given time (in minutes). A value of 0 means that the lamp won't be turned off. +.TP .B \-\-threshold percent -.RS - 0..100% (in steps of 1). Select minimum brightness to get a white point. Pixels +0..100% (in steps of 1). Select minimum brightness to get a white point. Pixels with brightness below that value will be scanned as black. -.RE +.TP .B \-\-brightness value -.RS - \-100..100 (in steps of 1). Set the brightness enhancement. 0 for no enhancement, negative -values to decrease brigthness, and positive values to increase it. -.RE +\-100..100 (in steps of 1). Set the brightness enhancement. 0 for no enhancement, negative +values to decrease brightness, and positive values to increase it. +.TP .B \-\-contrast value -.RS - \-100..100 (in steps of 1). Set the contrast enhancement. 0 for no enhancement, negative +\-100..100 (in steps of 1). Set the contrast enhancement. 0 for no enhancement, negative values to decrease contrast, and positive values to increase it. -.RE +.TP .B \-\-disable-interpolation yes|no -.RS - When using high resolutions where the horizontal resolution is smaller than vertical resolution, +When using high resolutions where the horizontal resolution is smaller than vertical resolution, data is expanded by software to preserve picture geometry. This can be disabled by this option to get real scanned data. -.RE +.TP .B \-\-disable-dynamic-lineart yes|no -.RS - Disable use of a software adaptive algorithm to generate lineart and rely on hardware lineart. -.RE +Disable use of a software adaptive algorithm to generate lineart and rely on hardware lineart. +.TP .B \-\-color-filter None|Red|Green|Blue -.RS - When using gray or lineart this option selects the used color. Using a color filter +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 selected. -.RE +.TP .B \-\-lamp\-off\-scan -.RS - The lamp will be turned off during the scan. Calibration is still done with lamp on. -.RE +The lamp will be turned off during the scan. Calibration is still done with lamp on. +.TP .B \-\-clear\-calibration -.RS - Clear calibration cache data, triggering a new calibration for the device when the +Clear calibration cache data, triggering a new calibration for the device when the next scan will happen. -.RE +.TP .B \-\-calibration\-file -.RS - Specify the calibration file name to use. At least the directory containing the file -must exist, since it won't be created. This option is disabled if the backend is ran +Specify the calibration file name to use. At least the directory containing the file +must exist, since it won't be created. This option is disabled if the backend is run as root. It maybe used in case of sheet-fed scanners to share a calibration file for several users. -.RE +.TP .B \-\-expiration\-time -.RS - Specify the time (in minutes) a cached calibration is considered valid. If older than the given value, a new +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. -.RE .PP Additionally, several 'software' options are exposed by the backend. These @@ -139,35 +133,30 @@ capabilities. Please note that these features are somewhat simplistic, and may not perform as well as the native implementations. Note also that these features all require that the driver cache the entire image in memory. This will almost certainly result in a reduction of scanning speed. -.PP + +.TP .B \-\-swcrop -.RS - Requests the driver to detect the extremities of the paper within the larger +Requests the driver to detect the extremities of the paper within the larger image, and crop the empty edges. -.RE -.PP + +.TP .B \-\-swdeskew -.RS - Requests the driver to detect the rotation of the paper within the larger +Requests the driver to detect the rotation of the paper within the larger image, and counter the rotation. -.RE -.PP + +.TP .B \-\-swdespeck \-\-despeck X -.RS - Requests the driver to find and remove dots of X diameter or smaller from the +Requests the driver to find and remove dots of X diameter or smaller from the image, and fill the space with the average surrounding color. -.RE -.PP + +.TP .B \-\-swskip 0..100% (in steps of 1) [0] -.RS - Request driver to discard pages with low numbers of dark pixels. -.RE -.PP +Request driver to discard pages with low numbers of dark pixels. + +.TP .B \-\-swderotate[=(yes|no)] [no] -.RS - Request driver to detect and correct 90 degree image rotation. +Request driver to detect and correct 90 degree image rotation. -.PP .SH "SYSTEM ISSUES" This backend needs libusb-0.1.6 or later installed, and hasn't tested in other configuration than a linux kernel 2.6.9 or higher. However, it should work any @@ -211,13 +200,18 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the -environment variable ends with the directory separator character, then -the default directories are searched after the explicitly specified -directories. For example, setting +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator +character, then the default directories are searched after the explicitly +specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_GENESYS If the library was compiled with debug support enabled, this environment @@ -254,7 +248,9 @@ Syscan/Ambir DocketPORT 467/485/487/665/685 Xerox Travel Scanner 100, Onetouch 2400 .RE .TP -cncsolutions (http://www.cncsolutions.com.br) sponsored and supported the work on the Panasonic KV-SS080. +cncsolutions +.RI ( http://www.cncsolutions.com.br ) +sponsored and supported the work on the Panasonic KV-SS080. .br .TP Brian Paavo from Benthic Science Limited for donating a Canoscan LiDE 700F. @@ -275,27 +271,36 @@ Luc Verhaegen for donating a Canoscan LiDE 120. .SH "AUTHOR" Oliver Rauch .br -Henning Meier-Geinitz <henning@meier\-geinitz.de> +Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de > .br -Gerhard Jaeger <gerhard@gjaeger.de> +Gerhard Jaeger +.RI < gerhard@gjaeger.de > .br -St\['e]phane Voltz <stef.dev@free.fr> +St\['e]phane Voltz +.RI < stef.dev@free.fr > .br -Philipp Schmid <philipp8288@web.de> +Philipp Schmid +.RI < philipp8288@web.de > .br -Pierre Willenbrock <pierre@pirsoft.dnsalias.org> +Pierre Willenbrock +.RI < pierre@pirsoft.dnsalias.org > .br -Alexey Osipov <simba@lerlan.ru> for HP2400 final support +Alexey Osipov +.RI < simba@lerlan.ru > +for HP2400 final support .SH "LIMITATIONS" -Powersaving isn't implemented for gl646 based scanner. Dynamic (emulated from gray data and with dithering) isn't enabled for gl646 scanners. Hardware lineart is limited up to 600 dpi for gl847 based scanners, due to the way image sensors are built. -.br -.TP -This backend will be much slower if not using libusb\-1.0. So be sure that sane\-backends is built with the \-\-enable-libusb_1_0 option. -.br +Powersaving isn't implemented for gl646 based scanner. Dynamic (emulated from gray data and with dithering) +isn't enabled for gl646 scanners. Hardware lineart is limited up to 600 dpi for gl847 based scanners, +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. .SH "BUGS" -For the LiDE 200, the scanned data at 4800 dpi is obtained "as is" from sensor. It seems the windows driver does some digital processing -to improve it, which is not implemented in the backend. +For the LiDE 200, the scanned data at 4800 dpi is obtained "as is" from sensor. +It seems the windows driver does some digital processing to improve it, which is not implemented in the backend. .PP diff --git a/doc/sane-gphoto2.man b/doc/sane-gphoto2.man index 3e2a046..d98387e 100644 --- a/doc/sane-gphoto2.man +++ b/doc/sane-gphoto2.man @@ -11,9 +11,14 @@ This backend has only been tested with a handful of cameras so far. Patches to support other models are welcome. .PP Because of the limited testing of this backend, it is commented out -in @CONFIGDIR@/dll.conf by default. Either the comment +in +.I @CONFIGDIR@/dll.conf +by default. Either the comment character must be removed or the backend must be called explicitly. -E.g. `scanimage \-d gphoto2' or `xscanimage gphoto2'. +E.g. +.I "scanimage \-d gphoto2" +or +.IR "xscanimage gphoto2" . .SH "DEVICE NAMES" The current version of the backend only allows one camera to be connected. The device name is always "0". @@ -24,22 +29,32 @@ specify the characteristics of the camera to be used. Resolutions (high resolution, low resolution, and thumbnail size) are required since they are needed by the sane frontends, but can't be obtained through the gphoto2 interface. Valid ports and cameras can be obtained -by "gphoto2 \-\-list\-cameras" and "gphoto2 \-\-list\-ports". +by +.I "gphoto2 \-\-list\-cameras" +and +.I "gphoto2 \-\-list\-ports". .PP -The dumpinquiry line causes some information about the camera to -be printed. +The +.B dumpinquiry +line causes some information about the camera to be printed. .PP Empty lines and lines starting with a hash mark (#) are ignored. A sample configuration file is shown below: .PP -The "topfolder" line specifies the "fixed" part of the file path. For +The +.B topfolder +line specifies the "fixed" part of the file path. For example, on the Kodak DC-240, files are stored in the directory -/DCIM/100DC240. The /DCIM portion is constant, but 100DC240 will -change and must be read from the camera. In this case, the -line would read "topfolder=/DCIM" +.IR /DCIM/100DC240. +The +.I /DCIM +portion is constant, but 100DC240 will change and must be read from the camera. +In this case, the line would read "topfolder=/DCIM" .PP Some cameras don't implement a file structure and store all pictures -in the "/" directory. This is indicated by setting "subdirs=0" with +in the +.I "/" +directory. This is indicated by setting "subdirs=0" with "topfolder=/" .PP .RS @@ -80,13 +95,21 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory +.RI ( "." ) +and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_GPHOTO2 If the library was compiled with debugging support enabled, this @@ -99,7 +122,9 @@ Set to 1, 2, or 3, to enable various levels of debugging within the gphoto2 libraries. .SH "SEE ALSO" -sane(7) +.BR sane (7) +.BR scanimage (1) +.BR xscanimage (1) .SH AUTHOR Peter S. Fales @@ -112,6 +137,8 @@ Many, no doubt. .PP More general comments, suggestions, and inquiries about frontends or SANE should go to the SANE Developers mailing list -(see http://www.sane\-project.org/mailing\-lists.html for details). +(see +.I http://www.sane\-project.org/mailing\-lists.html +for details). You must be subscribed to the list, otherwise your mail won't be sent to the subscribers. diff --git a/doc/sane-gt68xx.man b/doc/sane-gt68xx.man index 2e6d3c5..8a1cff9 100644 --- a/doc/sane-gt68xx.man +++ b/doc/sane-gt68xx.man @@ -18,7 +18,7 @@ the scan area. If you own a scanner other than the ones listed on the gt68xx homepage that works with this backend, please let me know this by sending the scanner's exact model name and the USB vendor and device ids (e.g. from -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) or syslog) to me. Even if the scanner's name is only slightly different from the models already listed as supported, please let me know. .PP @@ -30,8 +30,8 @@ following web page: .SH LIBUSB ISSUES Please use libusb-0.1.8 or later. Without libusb or with older libusb versions all kinds of trouble can be expected. The scanner should be found by -sane\-find\-scanner without further actions. For setting permissions and general -USB information looks at +.BR sane\-find\-scanner (1) +without further actions. For setting permissions and general USB information looks at .BR sane\-usb (5). .PP @@ -163,13 +163,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_GT68XX If the library was compiled with debug support enabled, this environment @@ -196,7 +202,8 @@ export SANE_DEBUG_GT68XX=4 .I http://www.meier\-geinitz.de/sane/gt68xx .SH AUTHOR -Henning Meier-Geinitz <henning@meier\-geinitz.de> +Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de > .br The original gt68xx driver was written by Sergey Vlasov, Andreas Nowack, and David Stevenson. Thanks for sending patches and answering questions to them @@ -213,6 +220,11 @@ Support for buttons is missing. .PP More detailed bug information is available at the gt68xx backend homepage .IR http://www.meier\-geinitz.de/sane/gt68xx\-backend/ . +.br Please contact us if you find a bug or missing feature: -<sane\-devel@alioth-lists.debian.net>. Please send a debug log if your scanner isn't -detected correctly (see SANE_DEBUG_GT68XX above). +.RI < sane\-devel@alioth-lists.debian.net >. +.br +Please send a debug log if your scanner isn't +detected correctly (see +.B SANE_DEBUG_GT68XX +above). diff --git a/doc/sane-hp.man b/doc/sane-hp.man index 1aeaea8..7a6fa14 100644 --- a/doc/sane-hp.man +++ b/doc/sane-hp.man @@ -50,7 +50,9 @@ the kernel scanner driver or libusb. See .BR sane\-usb (5) for more details. .PP -The "hp" backend no longer supports OfficeJet multi-function peripherals. +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 @@ -60,8 +62,9 @@ the "HP OfficeJet Linux driver", available at Because Hewlett-Packard does no longer produce scanners that support SCL (beside the OfficeJets), the above list of supported scanners is complete. -Other HP scanners are not supported by the "hp" backend, but might be supported -by another one. See +Other HP scanners are not supported by the +.B sane\-hp +backend, but might be supported by another one. See .IR http://www.sane\-project.org/ . You can also watch the sane\-devel mailing list at .IR http://www.sane\-project.org/mailing\-lists.html . @@ -91,8 +94,11 @@ that corresponds to the parallel interface card that was shipped with the scanner. That is .IR /dev/hpscan . A special driver is required for this card. -See ftp://rvs.ctrl\-c.liu.se/pub/wingel/hpscan for details. If the link -does not work, try ftp://sunsite.unc.edu/pub/Linux/kernel/patches/scanners. +See +.I ftp://rvs.ctrl\-c.liu.se/pub/wingel/hpscan +for details. If the link +does not work, try +.IR ftp://sunsite.unc.edu/pub/Linux/kernel/patches/scanners . .SH CONFIGURATION The contents of the .I hp.conf @@ -126,10 +132,12 @@ the scanner is connected by USB. Option .B connect\-device specifies that the scanner is connected to the system by a special -device. Input/output is performed by read()/write()-operations +device. Input/output is performed by +.BR read ()/ write "()-operations" on the device. This option must be used for HP ScanJet Plus or scanners connected to USB which are accessed through a named device -(e.g. /dev/usb/scanner0). +(e.g. +.IR /dev/usb/scanner0 ). For device names that contain "usb", "uscanner" or "ugen", it is not necessary to specify option connect\-device. @@ -153,12 +161,13 @@ A sample configuration file is shown below: /dev/scanner # this is a comment /dev/hpscan - option connect\-device +option connect\-device .fi .ft R .RE .PP -/dev/scanner is typically a symlink to the actual SCSI scanner device. +.I /dev/scanner +is typically a symlink to the actual SCSI scanner device. .RE .SH FILES .TP @@ -187,13 +196,21 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory +.RI ( "." ) +and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_HP If the library was compiled with debug support enabled, this @@ -235,19 +252,26 @@ The backend will simulate this by software, but only for gray and 24 bit color. .TP .B Automatic Document Feeder (ADF) -For use of the ADF with xscanimage(1), first place paper in the ADF and +For use of the ADF with +.BR xscanimage (1), +first place paper in the ADF and then change option scan source to 'ADF'. Press 'change document' to load a sheet. Then press 'scan' to start a scan. Maybe it is sufficient to press 'scan' without 'change document' for repeated scans. The use of the preview window is not recommended when working with the ADF. -Setting a window to scan from ADF is not supported with xscanimage(1). -Try xsane(1). +Setting a window to scan from ADF is not supported with +.BR xscanimage (1). +Try +.BR xsane (1). .TP .B Immediate actions -Some actions in xscanimage(1) (i.e. unload, select media, calibrate) +Some actions in +.BR xscanimage (1) +(i.e. unload, select media, calibrate) have an immediate effect on the scanner without starting a scan. -These options can not be used with scanimage. +These options can not be used with +.BR scanimage (1). .SH TODO .TP @@ -267,7 +291,14 @@ These scanners are using an internal parallel-to-SCSI converter which is supported by the ppSCSI-driver (see above). .SH "SEE ALSO" -sane(7), sane\-scsi(5), sane\-usb(5) +.BR sane (7), +.BR sane\-scsi (5), +.BR sane\-usb (5) +.BR scanimage (1), +.BR xscanimage (1), +.BR scanimage (1) + .SH AUTHOR -The sane\-hp backend was written by Geoffrey T. Dairiki. HP PhotoSmart -PhotoScanner support by Peter Kirchgessner. +The sane\-hp backend was written by Geoffrey T. Dairiki. +.br +HP PhotoSmart PhotoScanner support by Peter Kirchgessner. diff --git a/doc/sane-hp3500.man b/doc/sane-hp3500.man index 5192983..777a713 100644 --- a/doc/sane-hp3500.man +++ b/doc/sane-hp3500.man @@ -20,7 +20,7 @@ If you own a scanner other than the ones listed above that works with this backend, please let us know this by sending the scanner's exact model name and the USB vendor and device ids (e.g. from .IR /proc/bus/usb/devices , -.I sane\-find\-scanner +.B sane\-find\-scanner (1) or syslog) to us. Even if the scanner's name is only slightly different from the models mentioned above, please let us know. .SH CONFIGURATION @@ -49,4 +49,5 @@ export SANE_DEBUG_HP3500=4 .I http://projects.troy.rollo.name/rt-scanners/ .SH AUTHOR -Troy Rollo <sane@troy.rollo.name> +Troy Rollo +.RI < sane@troy.rollo.name > diff --git a/doc/sane-hp3900.man b/doc/sane-hp3900.man index b623ee5..4c2e562 100644 --- a/doc/sane-hp3900.man +++ b/doc/sane-hp3900.man @@ -26,17 +26,21 @@ BenQ 5550 RTS8823L-01E * .ft R .RE .PP -More details can be found on the hp3900 backend homepage +More details can be found on the +.BR sane\-hp3900 (1) +backend homepage .IR http://sourceforge.net/projects/hp3900\-series/ . .PP This is ALPHA software. Keep your hand at the scanner's plug and unplug it, if -scanner does not start to scan. See also the BUGS section. +scanner does not start to scan. See also the +.B BUGS +section. .PP If you own a scanner other than the ones listed above that works with this backend, please let us know this by sending the scanner's exact model name and the USB vendor and device ids (e.g. from .IR /proc/bus/usb/devices , -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) or syslog) to us. Even if the scanner's name is only slightly different from the models mentioned above, please let us know. .PP @@ -77,13 +81,21 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory +.RI ( "." ) +and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"/etc/sane.d" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_HP3900 If the library was compiled with debug support enabled, this @@ -96,12 +108,15 @@ export SANE_DEBUG_HP3900=4 .SH "SEE ALSO" .BR sane (7), .BR sane\-usb (5), +.BR sane\-find\-scanner (1), .br .I http://sourceforge.net/projects/hp3900\-series/ +.br .I http://jkdsoftware.dyndns.org/drupal/?q=es/books/151 .SH AUTHOR -Jonathan Bravo Lopez <jkdsoft@gmail.com> +Jonathan Bravo Lopez +.RI < jkdsoft@gmail.com > .SH BUGS Scanning is only tested with Linux/ix86/gcc. Be careful when testing on other diff --git a/doc/sane-hp4200.man b/doc/sane-hp4200.man index cbb8c5e..7d92cde 100644 --- a/doc/sane-hp4200.man +++ b/doc/sane-hp4200.man @@ -26,7 +26,7 @@ If you own a scanner other than the ones listed above that works with this backend, please let us know this by sending the scanner's exact model name and the USB vendor and device ids (e.g. from .IR /proc/bus/usb/devices , -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) or syslog) to us. Even if the scanner's name is only slightly different from the models mentioned above, please let us know. .PP @@ -68,13 +68,21 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory +.RI ( "." ) +and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_HP4200 If the library was compiled with debug support enabled, this @@ -87,12 +95,14 @@ export SANE_DEBUG_HP4200=4 .SH "SEE ALSO" .BR sane (7), .BR sane\-usb (5), +.BR sane\-find\-scanner (1), .br .I http://hp4200\-backend.sourceforge.net/ .SH AUTHOR Adrian Perez Jorge, Andrew John Lewis, Arnar Mar Hrafnkelsson, Frank Zago, -Henning Meier-Geinitz. Current maintainer: Henning Meier-Geinitz <henning@meier\-geinitz.de>. +Henning Meier-Geinitz. Current maintainer: Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de >. .SH BUGS Tested only with Linux. @@ -102,4 +112,4 @@ Only 8 bit color mode works. Scanning is slow due to backtracking. .PP Send bug reports to the sane\-devel mailing list: -sane\-devel@alioth-lists.debian.net. +.IR sane\-devel@alioth-lists.debian.net . diff --git a/doc/sane-hp5400.man b/doc/sane-hp5400.man index 23c40d8..4738c08 100644 --- a/doc/sane-hp5400.man +++ b/doc/sane-hp5400.man @@ -26,7 +26,7 @@ If you own a scanner other than the ones listed above that works with this backend, please let us know this by sending the scanner's exact model name and the USB vendor and device ids (e.g. from .IR /proc/bus/usb/devices , -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) or syslog) to us. Even if the scanner's name is only slightly different from the models mentioned above, please let us know. .PP @@ -68,13 +68,21 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory +.RI ( "." ) +and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_HP5400 If the library was compiled with debug support enabled, this @@ -87,13 +95,17 @@ export SANE_DEBUG_HP5400=4 .SH "SEE ALSO" .BR sane (7), .BR sane\-usb (5), +.BR sane\-find\-scanner (1), .br .I http://hp5400backend.sourceforge.net/ .SH AUTHOR -Martijn van Oosterhout <kleptog@svana.org>, Thomas Soumarmon -<soumarmt@nerim.net>. Manpage by Henning Meier-Geinitz -<henning@meier\-geinitz.de>. +Martijn van Oosterhout +.RI < kleptog@svana.org >, +Thomas Soumarmon +.RI < soumarmt@nerim.net >. +Manpage by Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de >. .SH BUGS Scanning is only tested with Linux/ix86/gcc. Be careful when testing on other diff --git a/doc/sane-hp5590.man b/doc/sane-hp5590.man index 5330800..e0448d6 100644 --- a/doc/sane-hp5590.man +++ b/doc/sane-hp5590.man @@ -8,9 +8,10 @@ sane-hp5590 - SANE backend for Hewlett-Packard 4500C/4570C/5500C/5550C/5590/7650 Workgroup/Document scanners .SH DESCRIPTION .PP -The \f[B]sane-hp5590\f[R] library implements a SANE (Scanner Access Now -Easy) backend that provides access to the following Hewlett-Packard -Workgroup/Document scanners: +The +.B sane-hp5590 +library implements a SANE (Scanner Access Now Easy) backend that provides access +to the following Hewlett-Packard Workgroup/Document scanners: .IP \[bu] 2 ScanJet 4500C .IP \[bu] 2 @@ -27,15 +28,20 @@ ScanJet 7650 If you own a scanner other than the ones listed above that works with this backend, please let us know this by sending the scanner\[cq]s exact model name and the USB vendor and device ids (e.g.\ from -\f[I]/sys/bus/usb/devices\f[R], \f[I]sane-find-scanner\f[R] or syslog) -to us. +.IR /sys/bus/usb/devices , +.BR sane-find-scanner (1) +or syslog) to us. Even if the scanner\[cq]s name is only slightly different from the models mentioned above, please let us know. .SH OPTIONS .PP The options the backend supports can either be selected through command -line options to programs like scanimage or through GUI elements in -\f[I]xscanimage\f[R] or \f[I]xsane\f[R]. +line options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +or +.BR xsane (1). Valid command line options and their syntax can be listed by using: .IP .nf @@ -46,8 +52,12 @@ scanimage --help -d hp5590:interface:device .PP where \f[I]interface\f[R] and \f[I]device\f[R] specify the device in question, as in the configuration file. -Add \f[I]--all-options\f[R] to also list the hardware read-out options. -The -d parameter and its argument can be omitted to obtain information +Add +.B --all-options +to also list the hardware read-out options. +The +.B \-d +parameter and its argument can be omitted to obtain information on the first scanner identified. .PP Use the command: @@ -148,9 +158,7 @@ Request a preview-quality scan. Hide end-of-page indicator pixels and overwrite with color of next neighbor pixels. (Default: yes) -.PD 0 -.P -.PD +.br The scanner uses the last pixel in every scan line for storing the end-of-page status. This is needed to detect the end of the document sheet when the @@ -184,9 +192,7 @@ feeder (ADF) is used. Set color value for filling trailing scan lines in trailing lines mode \[lq]color\[rq] (see previous option). (Default color: violet) -.PD 0 -.P -.PD +.br The RGB color value must be specified and calculated as 65536 * r + 256 * g + b, with r, g, b being values in the range of 0 .. 255. @@ -196,47 +202,57 @@ The following options allow reading out the button state, counter value, color setting, and the state of document in ADF. This can be used to programmatically control corresponding scanner options like switching between \f[I]flatbed\f[R] and \f[I]ADF\f[R] mode, -or triggering prost processing tasks after scanning. +or triggering post processing tasks after scanning. .TP .B --button-pressed Get the id of the last button pressed. Id is one of \[lq]none\[rq], \[lq]power\[rq], \[lq]scan\[rq], \[lq]collect\[rq], \[lq]file\[rq], \[lq]email\[rq], \[lq]copy\[rq], \[lq]up\[rq], \[lq]down\[rq], \[lq]mode\[rq], \[lq]cancel\[rq]. -.PD 0 -.P -.PD +.br The scanner stores the id of the last button pressed until it is read. After read out, the state is reset and subsequent readings will return \[lq]none\[rq]. + .TP .B --color-led Get the state of the color LED indicators. The state is either \[lq]color\[rq] or \[lq]black_white\[rq]. + .TP .B --counter-value Get the counter value as shown on LCD. The value is in the range of 1 .. 99. + .TP .B --doc-in-adf Get the state of the document-available indicator of the automatic document feeder (ADF). The state is either \[lq]yes\[rq] or \[lq]no\[rq]. + .SH HINTS FOR USERS OF SCANBD .PP -\f[I]Scanbd\f[R] is a scanner button daemon, which can read scanner +.BR scanbd (8) +is a scanner button daemon, which can read scanner buttons and trigger scan actions. .PP -Do not use the old \f[I]scanbuttond\f[R] interface with hp5590. +Do not use the old +.BR scanbuttond (8) +interface with hp5590. It is outdated and shall not be used any more. -Scanbd\[cq]s regular interface is fully supported by the current version +The regular interface of +.BR scanbd (8) +is fully supported by the current version of the \f[I]hp5590\f[R] backend. .PP This example shows a minimum configuration file and the corresponding -script file for scanbd to be included in \f[I]scanbd.conf\f[R]. +script file for +.BR scanbd (8) +to be included in +.IR scanbd.conf . .IP \[bu] 2 -\f[B]hp5590.conf\f[R] +.I hp5590.conf .IP .nf \f[C] @@ -315,6 +331,13 @@ Higher debug levels increase the verbosity of the output: export SANE_DEBUG_HP5590=50 .SH SEE ALSO .PP -\f[B]sane\f[R](7), \f[B]sane-usb\f[R](5) +.BR sane (7), +.BR sane\-usb (5) +.BR scanbd (8), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1) + .SH AUTHORS -Ilia Sotnikov <hostcc@gmail.com>. +Ilia Sotnikov +.RI < hostcc@gmail.com >. diff --git a/doc/sane-hpljm1005.man b/doc/sane-hpljm1005.man index ff1006a..a679d89 100644 --- a/doc/sane-hpljm1005.man +++ b/doc/sane-hpljm1005.man @@ -16,7 +16,7 @@ If you own a scanner other than the ones listed above that works with this backend, please let us know this by sending the scanner's exact model name and the USB vendor and device ids (e.g. from .IR /proc/bus/usb/devices , -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) or syslog) to us. Even if the scanner's name is only slightly different from the models mentioned above, please let us know. .SH CONFIGURATION @@ -29,9 +29,22 @@ The static library implementing this backend. .I @LIBDIR@/libsane\-hpljm1005.so The shared library implementing this backend (present on systems that support dynamic loading). + +.SH "ENVIRONMENT" +.TP +.B SANE_DEBUG_HPLJM1005 +If the library was compiled with debug support enabled, this environment +variable controls the debug level for this backend. Higher debug levels +increase the verbosity of the output. + +There is not currently a great deal of diagnostic output, it being mainly +confined to error conditions. + .SH "SEE ALSO" .BR sane (7), .BR sane\-usb (5), +.BR sane\-find\-scanner (1) .SH AUTHOR -Philippe R\['e]tornaz <couriousous@mandriva.org> +Philippe R\['e]tornaz +.RI < couriousous@mandriva.org > diff --git a/doc/sane-hpsj5s.man b/doc/sane-hpsj5s.man index d42b49e..aae2f51 100644 --- a/doc/sane-hpsj5s.man +++ b/doc/sane-hpsj5s.man @@ -15,13 +15,17 @@ I consider it extremely improbable) that your scanner will be damaged. .PP LIMITATIONS: For now this backend works only on Linux. This limitation -is due to dependence on the libieee1284 library. If your system supports libieee1284 too, -this backend should work. If you ported libieee1284 for your platform, please let -me know. Your system should support +is due to dependence on the +.BR libieee1284 (3) +library. If your system supports +.BR libieee1284 (3) +too,this backend should work. If you ported +.BR libieee1284 (3) +for your platform, please let me know. Your system should support .B EPP (or -.B EPP+ECP -) mode to operate this scanner. Future versions will support ECP and SPP +.BR EPP+ECP ) +mode to operate this scanner. Future versions will support ECP and SPP (Nibble and Byte) modes also. It's planned to support scanners not only at daisy-chain position 0, but anywhere. Support for multiple scanners could be implemented too. @@ -30,7 +34,8 @@ Current version implements only gray scale scanning. True Color and B/W modes ar not supported for now. .PP That said, TESTERS ARE WELCOME. Send your bug reports and comments to -Max Vorobiev <pcwizard@yandex.ru>. +Max Vorobiev +.RI < pcwizard@yandex.ru >. .PP .SH "DEVICE NAMES" This backend expects device names of the form: @@ -41,8 +46,9 @@ This backend expects device names of the form: .PP Where .I special -is the parallel port name in form, libieee1284 expects. It seems to be system dependent. -Under Linux it's parport0, parport1, etc. +is the parallel port name in form, +.BR libieee1284 (3) +expects. It seems to be system dependent. Under Linux it's parport0, parport1, etc. .SH CONFIGURATION The contents of the .I hpsj5s.conf @@ -81,23 +87,35 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). - +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP +.B SANE_DEBUG_HPSJ5S +If the library was compiled with debug support enabled, this environment +variable controls the debug level for this backend. Higher debug levels +increase the verbosity of the output. + .SH "SEE ALSO" -sane(7) +.BR sane (7), +.BR libieee1284 (3) .br -http://hpsj5s.sourceforge.net +.I http://hpsj5s.sourceforge.net .br -http://cyberelk.net/tim/libieee1284 +.I http://cyberelk.net/tim/libieee1284 .br .SH AUTHOR Max Vorobiev .br -Man page mostly based on canon.man +Man page mostly based on +.IR canon.man . diff --git a/doc/sane-hs2p.man b/doc/sane-hs2p.man index 9757eff..fcbdae1 100644 --- a/doc/sane-hs2p.man +++ b/doc/sane-hs2p.man @@ -25,7 +25,7 @@ Where .I special is either the path-name for the special device that corresponds to a SCSI scanner. The program -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) helps to find out the correct device. Under Linux, such a device name could be .I /dev/sg0 or @@ -64,13 +64,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_HS2P If the library was compiled with debug support enabled, this @@ -78,7 +84,9 @@ environment variable controls the debug level for this backend. A value of 255 prints all debug output. Smaller values reduce verbosity. .SH CURRENT STATUS -The hs2p backend is now in version 1.00. All major scanning-related features +The +.B sane\-hs2p +backend is now in version 1.00. All major scanning-related features are supported, except for those features requiring the optional IPU. Scanning from the flatbed or ADF (either simplex or duplex) is supported. Lineart, halftone, 4-bit gray, and 8-bit gray are supported. Pre-set gamma tables and @@ -106,8 +114,9 @@ suited to a stand-alone utility to be used by a technician when replacing the lamp or ADF unit. Nor is support for reading or changing IPU (93H) parameters and adjustments planned, since my IS450 lacks such a unit. The 31-byte Auto Photo/Letter struct and 21-byte Dynamic -threshold struct are documented in the hs2p-scsi.h file should someone -wish to use their IPU for image data processing. +threshold struct are documented in the +.I hs2p-scsi.h +file should someone wish to use their IPU for image data processing. .SH "SEE ALSO" .BR sane (7), @@ -115,6 +124,8 @@ wish to use their IPU for image data processing. .BR sane\-scsi (5), .SH AUTHOR -jeremy <jeremy@acjlaw.net> +jeremy +.RI < jeremy@acjlaw.net > .br -Maintained by Jeremy Johnson <jeremy@acjlaw.net> +Maintained by Jeremy Johnson +.RI < jeremy@acjlaw.net > diff --git a/doc/sane-ibm.man b/doc/sane-ibm.man index 0b5013c..1ecb285 100644 --- a/doc/sane-ibm.man +++ b/doc/sane-ibm.man @@ -25,7 +25,7 @@ Where .I special is either the path-name for the special device that corresponds to a SCSI scanner. The program -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) helps to find out the correct device. Under Linux, such a device name could be .I /dev/sg0 or @@ -64,13 +64,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_IBM If the library was compiled with debug support enabled, this @@ -83,6 +89,8 @@ debug levels increase the verbosity of the output. .BR sane\-scsi (5), .SH AUTHOR -mf <massifr@tiscalinet.it> +mf +.RI < massifr@tiscalinet.it > .br -Maintained by Henning Meier-Geinitz <henning@meier\-geinitz.de> +Maintained by Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de > diff --git a/doc/sane-kodak.man b/doc/sane-kodak.man index 61ea88e..9b89c2b 100644 --- a/doc/sane-kodak.man +++ b/doc/sane-kodak.man @@ -16,7 +16,8 @@ This document describes backend version 7, which shipped with SANE 1.0.21. This version should support models which speak the Kodak SCSI and Firewire protocols. The i1860 was used to develop the backend, but other models may work with only minimal modifications. Please see the list at -http://www.sane\-project.org/sane\-supported\-devices.html for an updated list. +.I http://www.sane\-project.org/sane\-supported\-devices.html +for an updated list. If you have a machine not on that list, or reported as 'untested': the best way to determine level of support is to test the scanner directly, or to collect a @@ -31,42 +32,47 @@ may be supported by another backend. .SH OPTIONS Effort has been made to expose the basic hardware options, including: .PP -source s +.B --source s .RS Selects the source for the scan. Options may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex". .RE .PP -mode m +.B --mode m .RS Selects the mode for the scan. Options may include "Lineart", "Halftone", "Gray", and "Color". .RE .PP -resolution +.B --resolution .RS Controls scan resolution. Available choices may be limited by mode. .RE .PP -tl\-x, tl\-y, br\-x, br\-y +.BR --tl\-x ", " --tl\-y ", " --br\-x ", " --br\-y .RS Sets scan area upper left and lower right coordinates. These are renamed -t, l, x, y by some frontends. +.BR -t ", " -l ", " -x ", " -y +by some frontends. .RE .PP -page\-width, page\-height +.BR --page\-width ", " --page\-height .RS Sets paper size. Used by scanner to determine centering of scan coordinates when using ADF and to detect double feed errors. .RE .PP Other options will be available based on the capabilities of the scanner. -Use 'scanimage \-\-help' to get a list, but be aware that some options may +Use +.I scanimage \-\-help +to get a list, but be aware that some options may be settable only when another option has been set, and that advanced options may be hidden by some frontend programs. .PP .SH CONFIGURATION FILE -The configuration file "kodak.conf" is used to tell the backend how to look +The configuration file +.I kodak.conf +is used to tell the backend how to look for scanners, and provide options controlling the operation of the backend. This file is read each time the frontend asks the backend for a list of scanners, generally only when the frontend starts. If the configuration @@ -77,7 +83,7 @@ Scanners can be specified in the configuration file in 2 ways: .PP "scsi KODAK" .RS -Requests backend to search all scsi busses in the system for a device +Requests backend to search all scsi buses in the system for a device which reports itself to be a scanner made by 'KODAK'. .RE .PP @@ -104,8 +110,9 @@ warned. .PP .SH ENVIRONMENT -The backend uses a single environment variable, SANE_DEBUG_KODAK, which -enables debugging output to stderr. Valid values are: +The backend uses a single environment variable, +.BR SANE_DEBUG_KODAK , +which enables debugging output to stderr. Valid values are: .PP .RS 5 Errors @@ -130,13 +137,17 @@ endorser, iThresholding, multi\-stream, etc. .PP .SH CREDITS -The various authors of the sane\-fujitsu backend provided useful code. +The various authors of the +.BR sane\-fujitsu (5) +backend provided useful code. .br Kodak provided access to hardware, documentation and personnel. .SH "SEE ALSO" -sane(7), -sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5), +.BR scanimage (1) .SH AUTHOR -m. allan noah: <kitno455 a t gmail d o t com> +m. allan noah: +.RI < "kitno455 a t gmail d o t com" > diff --git a/doc/sane-kodakaio.man b/doc/sane-kodakaio.man index 664a418..6c94ce0 100644 --- a/doc/sane-kodakaio.man +++ b/doc/sane-kodakaio.man @@ -8,7 +8,7 @@ sane\-kodakaio \- SANE backend for Kodak aio printer / scanners The .B sane\-kodakaio library implements a SANE (Scanner Access Now Easy) backend which -provides access to Kodak aio printer / scanners, like the ESP and Hero series. +provides access to Kodak aio printer/scanners, like the ESP and Hero series. This document describes backend version 2.4, which is the first candidate for incorporation in sane-backends. @@ -22,19 +22,27 @@ If you have a model not on that list, or reported as 'untested': the best way to determine level of support is to test the scanner directly. .SH CONFIGURATION FILE -The configuration file "kodakaio.conf" is used to tell the backend how to look +The configuration file +.I kodakaio.conf +is used to tell the backend how to look for scanners, and provide options controlling the operation of the backend. This file is read each time the frontend asks the backend for a list of scanners, generally only when the frontend starts. .SH ENVIRONMENT -The backend uses a single environment variable, SANE_DEBUG_KODAKAIO, which -enables debugging output to stderr. +.TP +.B SANE_DEBUG_KODAKAIO +If the library was compiled with debug support enabled, this +environment variable controls the debug level for this backend. Higher +debug levels increase the verbosity of the output. .SH KNOWN ISSUES Most hardware options are either not supported or not exposed for control by the user, including: multifeed detection, image compression etc. .PP +.SH "SEE ALSO" +.BR sane (7) + .SH AUTHOR P. Newall diff --git a/doc/sane-kvs1025.man b/doc/sane-kvs1025.man index 23a67f3..d366c0b 100644 --- a/doc/sane-kvs1025.man +++ b/doc/sane-kvs1025.man @@ -24,7 +24,9 @@ sanei_usb instead of libusb by m. allan noah. The backend was tested on KV-S1025C and 1045C by Tiago Zaniquelli. .SH "SEE ALSO" -sane(7), sane\-usb(5) +.BR sane (7) , +.BR sane\-usb (5) .SH AUTHOR -m. allan noah: <kitno455 a t gmail d o t com> +m. allan noah: +.RI < "kitno455 a t gmail d o t com" > diff --git a/doc/sane-kvs20xx.man b/doc/sane-kvs20xx.man index bd3ecc2..3be7c5e 100644 --- a/doc/sane-kvs20xx.man +++ b/doc/sane-kvs20xx.man @@ -2,7 +2,7 @@ .IX sane\-kvs20xx .SH NAME -sane\-kvs20xx \- SANE backend for Panasonic KV-S20xxC USB/SCSI ADF scanners. +sane\-kvs20xx \- SANE backend for Panasonic KV-S20xxC USB/SCSI ADF scanners .SH DESCRIPTION The @@ -22,7 +22,10 @@ The backend was ported to sane-backends 1.0.22 and downgraded to C89 by m. allan noah. .SH "SEE ALSO" -sane(7), sane\-usb(5), sane\-scsi(5) +.BR sane (7), +.BR sane\-usb (5), +.BR sane\-scsi (5) .SH AUTHOR -m. allan noah: <kitno455 a t gmail d o t com> +m. allan noah: +.RI < "kitno455 a t gmail d o t com" > diff --git a/doc/sane-kvs40xx.man b/doc/sane-kvs40xx.man index 5a53853..45ad606 100644 --- a/doc/sane-kvs40xx.man +++ b/doc/sane-kvs40xx.man @@ -24,7 +24,10 @@ The backend was ported to sane-backends 1.0.23 and downgraded to C89 by m. allan noah. .SH "SEE ALSO" -sane(7), sane\-usb(5), sane\-scsi(5) +.BR sane (7), +.BR sane\-usb (5), +.BR sane\-scsi (5) .SH AUTHOR -m. allan noah: <kitno455 a t gmail d o t com> +m. allan noah: +.RI < "kitno455 a t gmail d o t com" > diff --git a/doc/sane-leo.man b/doc/sane-leo.man index f0d9266..00ec8fd 100644 --- a/doc/sane-leo.man +++ b/doc/sane-leo.man @@ -19,14 +19,18 @@ The scanners that should work with this backend are: Vendor Model status ---------------------- ----------- Across FS-1130 tested - Leo S3 tested + LEO S3 tested .fi .ft R .RE The options the backend supports can either be selected through -command line options to programs like scanimage or through GUI -elements in xscanimage or xsane. +command line options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +or +.BR xsane (1). .br If you have any strange behavior, please report to the backend @@ -112,7 +116,10 @@ selected. The default is "no". .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/leo.conf supports only one information: the device name to use (eg /dev/scanner). +The configuration file +.I @CONFIGDIR@/leo.conf +supports only one information: the device name to use (eg +.IR /dev/scanner ). .SH FILES @@ -140,14 +147,17 @@ backend. However they are only software adjustments. This backend only implements what the scanner can support. -.SH BUGS - +SH BUGS None known. .SH "SEE ALSO" -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1), +.BR sane (7) .SH AUTHOR diff --git a/doc/sane-lexmark.man b/doc/sane-lexmark.man index 06e3359..3ab9f8f 100644 --- a/doc/sane-lexmark.man +++ b/doc/sane-lexmark.man @@ -26,22 +26,27 @@ The scanners that should work with this backend are: Lexmark X1180 good Lexmark X1185 complete Lexmark X12xx good in USB1.1, - not fully tested in USB2.0 + not fully tested in USB2.0 Dell A920 good .fi .ft R .RE The options the backend supports can either be selected through -command line options to programs like scanimage or through GUI -elements in xscanimage or xsane. +command line options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +or +.BR xsane (1). .br -If you have any strange behavior, please report to the backend +If you notice any strange behavior, please report to the backend maintainer or to the SANE mailing list. Valid command line options and their syntax can be listed by using .RS +.PP scanimage \-\-help \-d lexmark:usb:<usb port> .RE @@ -92,7 +97,9 @@ The default value of the threshold option is 50. .SH "CONFIGURATION FILE" -The configuration file @CONFIGDIR@/lexmark.conf contains only the usb device id (eg usb 0x043d 0x007c). +The configuration file +.I @CONFIGDIR@/lexmark.conf +contains only the usb device id (eg usb 0x043d 0x007c). .SH "FILES" @@ -108,12 +115,13 @@ support dynamic loading). .SH "ENVIRONMENT" .TP .B SANE_DEBUG_LEXMARK -.B SANE_DEBUG_LEXMARK_LOW 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. - +.TP +.B SANE_DEBUG_LEXMARK_LOW +Provides debug output for low level Lexmark functions. .SH "LIMITATIONS" The windows TWAIN driver has many more options than this SANE @@ -131,7 +139,11 @@ No bugs currently known. .SH "SEE ALSO" -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1), +.BR sane (7) .SH "AUTHOR" @@ -142,10 +154,12 @@ The backend was originally written by Fred Odendaal. The new version is currently developed by St\['e]phane Voltz. .I http://stef.dev.free.fr/sane/lexmark .TP -X74 support was written by Torsten Houwaart (<ToHo@gmx.de>) +X74 support was written by Torsten Houwaart +.RI < ToHo@gmx.de > + .SH "CREDITS" .TP Many thanks go to: -Julien Furgerot who lend me a Dell A920. +Julien Furgerot who lent me a Dell A920. Robert Price, Dani Ele and Dalai Felinto for the time they spent recording USB activity and testing the experimental version. diff --git a/doc/sane-ma1509.man b/doc/sane-ma1509.man index 2677fcd..e6b3a7e 100644 --- a/doc/sane-ma1509.man +++ b/doc/sane-ma1509.man @@ -96,13 +96,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_MA1509 If the library was compiled with debug support enabled, this @@ -121,7 +127,8 @@ debug levels increase the verbosity of the output. .I http://www.meier\-geinitz.de/sane/ma1509\-backend/ .SH AUTHOR -Henning Meier-Geinitz <henning@meier\-geinitz.de> +Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de > .SH BUGS Resolutions higher than 600 dpi don't work diff --git a/doc/sane-magicolor.man b/doc/sane-magicolor.man index 17ef387..8b2446a 100644 --- a/doc/sane-magicolor.man +++ b/doc/sane-magicolor.man @@ -43,19 +43,28 @@ The static library implementing this backend. .TP .I @LIBDIR@/libsane\-magicolor.so The shared library implementing this backend (present on systems that support dynamic loading). + .SH "ENVIRONMENT" .TP .B SANE_CONFIG_DIR -This environment variable specifies the list of directories that may contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi\-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working directory (".") and then in @CONFIGDIR@. If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting +This environment variable specifies the list of directories that may contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi\-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "/tmp/config", ".", and "@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "/tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_MAGICOLOR If the library was compiled with debug support enabled, this environment variable controls the debug level for this backend. Higher debug levels increase the verbosity of the output. Example: export SANE_DEBUG_MAGICOLOR=127 -To obtain debug messages from the backend, set this environment variable before calling your favorite frontend (e.g. xscanimage). +To obtain debug messages from the backend, set this environment variable before calling your favorite frontend (e.g. +.BR xscanimage (1)). Example: SANE_DEBUG_MAGICOLOR=65 xscanimage .SH "KNOWN BUGS AND RESTRICTIONS" @@ -63,10 +72,13 @@ Example: SANE_DEBUG_MAGICOLOR=65 xscanimage Large color scans may sometimes timeout due to unknown reasons (the scanner simply stops returning data) .PP Cancelling large scans may lock up the scanner. + .SH "SEE ALSO" .BR sane (7), .br .I http://wiki.kainhofer.com/hardware/magicolor_scan + .SH "AUTHOR" .PP -Reinhold Kainhofer <reinhold@kainhofer.com> +Reinhold Kainhofer +.RI < reinhold@kainhofer.com > diff --git a/doc/sane-matsushita.man b/doc/sane-matsushita.man index 5bbf734..2030f2c 100644 --- a/doc/sane-matsushita.man +++ b/doc/sane-matsushita.man @@ -33,6 +33,7 @@ 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 .RS +.PP scanimage \-\-help \-d matsushita .RE @@ -103,8 +104,11 @@ options set the gamma curve. It is only valid for Gray modes, and is not availab .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/matsushita.conf supports the device name to use (eg /dev/scanner) and the SCSI option to auto-detect the scanners supported. - +The configuration file +.I @CONFIGDIR@/matsushita.conf +supports the device name to use (eg +.IR /dev/scanner ) +and the SCSI option to auto-detect the scanners supported. .SH FILES .TP @@ -144,22 +148,25 @@ The backend does not support the setting of different options for each side. The .SH SCANNING EXAMPLE To date, the only frontend capable of using this scanner at full speed is -.B -scanadf. +.BR scanadf (1). -A scanadf command line would be: +A +.BR scanadf (1) +command line would be: scanadf \-d matsushita \-\-output\-file scan%04d.pbm \-\-start\-count 0 \-\-duplex \-\-resolution 300 \-\-feeder\-mode="All pages" \-\-paper\-size="A4" .SH BUGS - None known. .SH "SEE ALSO" - -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1), +.BR sane (7) .SH AUTHOR diff --git a/doc/sane-microtek.man b/doc/sane-microtek.man index d3bf21c..cb42aa3 100644 --- a/doc/sane-microtek.man +++ b/doc/sane-microtek.man @@ -50,7 +50,7 @@ The driver does .B not support the newest Microtek scanners, such as the V330 and V660, which use a new and very different SCSI-II command set. For those, try the alternate -.B microtek2 +.BR microtek2 (5) backend. Most non-SCSI scanners would use the new command set. Most scanners newer than the Scanmaker E6 would use the new command set. .PP @@ -63,8 +63,9 @@ Although this manual page is generally updated with each release, up-to-date information on new releases and extraneous helpful hints are available from the backend homepage: .br +.PP .RS -.B http://www.mir.com/mtek/ +.I http://www.mir.com/mtek/ .RE .SH "DEVICE NAMES" @@ -134,13 +135,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_MICROTEK If the library was compiled with debugging support enabled, this @@ -149,7 +156,9 @@ A value of 128 requests maximally copious debug output; smaller levels reduce verbosity. .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5), +.BR sane\-microtek2 (5) .SH AUTHOR Matt Marjanovic @@ -177,11 +186,12 @@ option in the configuration file (first one, then both), and see if it helps. (If it does, report it.) .PP Send lengthy bug reports and new scanner information to -.BR mtek\-bugs@mir.com . +.IR mtek\-bugs@mir.com . All bug reports and new scanner inquiries should include an error log file. You can generate copious -stderr output by setting the SANE_DEBUG_MICROTEK environment variable -described above. For example: +stderr output by setting the +.B SANE_DEBUG_MICROTEK +environment variable described above. For example: .PP .RS setenv SANE_DEBUG_MICROTEK 128 @@ -189,6 +199,7 @@ setenv SANE_DEBUG_MICROTEK 128 .PP More general comments, suggestions, and inquiries about frontends or SANE should go to -.BR sane\-devel@alioth-lists.debian.net , +.IR sane\-devel@alioth-lists.debian.net , the SANE Developers mailing list. Have a look at -http://www.sane\-project.org/mailing\-lists.html concerning subscription to sane\-devel. +.I http://www.sane\-project.org/mailing\-lists.html +concerning subscription to sane\-devel. diff --git a/doc/sane-microtek2.man b/doc/sane-microtek2.man index cc4f6f4..45756ed 100644 --- a/doc/sane-microtek2.man +++ b/doc/sane-microtek2.man @@ -9,15 +9,17 @@ 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 -.B http://karstenfestag.gmxhome.de +.IR http://karstenfestag.gmxhome.de . .PP There exists a different backend for Microtek scanners with SCSI-1 command set. -Refer to sane\-microtek(5) for details. +Refer to +.BR sane\-microtek (5) +for details. .PP And there is work in progress for the ScanMaker 3600. See -.B http://sourceforge.net/projects/sm3600 +.IR http://sourceforge.net/projects/sm3600 . .PP At present, the following scanners are known positively to work with this backend: @@ -53,7 +55,7 @@ Scanpaq SQ2030 Parport .ft R .PP Additional information can be found at -.BR http://www.sane\-project.org/ . +.IR http://www.sane\-project.org/ . .PP If you own a Microtek scanner other than the ones listed above, it may or may not work with SANE! Because equal scanners are sold under @@ -109,7 +111,9 @@ supported by the scanner in dependence of the scanning-mode and other options. Not supported options are disabled. .PP -The following options are supported by the Microtek2-driver: +The following options are supported by the +.B sane\-microtek2 +driver: .PP Color, grayscale, halftone and lineart scans. .PP @@ -299,15 +303,19 @@ 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. To see error messages on stderr set -SANE_DEBUG_MICROTEK2 to 1 (Remark: The whole debugging levels should -be better revised). +.B SANE_DEBUG_MICROTEK2 +to 1 (Remark: The whole debugging levels should be better revised). .br E.g. just say: .br export SANE_DEBUG_MICROTEK2=128 + .SH "SEE ALSO" -sane\-scsi(5), sane(7) +.BR sane\-scsi(5) , +.BR sane (7) + .SH "AUTHORS" Bernd Schroeder (not active anymore) .br -Karsten Festag karsten.festag@gmx.de +Karsten Festag +.RI < karsten.festag@gmx.de >. diff --git a/doc/sane-mustek.man b/doc/sane-mustek.man index f06d9c1..925e6d8 100644 --- a/doc/sane-mustek.man +++ b/doc/sane-mustek.man @@ -95,8 +95,9 @@ and a debug output to .IR sane\-devel@alioth-lists.debian.net . You can get the debug output by setting the environment variable .B SANE_DEBUG_MUSTEK -to 5 and showing the list of available scanners with scanimage \-L. Please -send all of it to the mailing list. You must be subscribed to sane\-devel +to 5 and showing the list of available scanners with +.IR "scanimage \-L" . +Please send all of it to the mailing list. You must be subscribed to sane\-devel before you can send mail to the list. See .I http://www.sane\-project.org/mailing\-lists.html for details. @@ -116,7 +117,7 @@ be found (see section .B "PARALLEL PORT SCANNERS" below). For SCSI scanners, the special device name must be a generic SCSI device or a symlink to such a device. The program -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) helps to find out the correct device. Under Linux, such a device name could be .I /dev/sg0 @@ -220,8 +221,9 @@ Finally, is a global option. If set, the backend will wait until the device is ready before sending the inquiry command. Further more the backend will force the scan slider to return to its starting position (not implemented for all -scanners). This option may be necessary with the 600 II N or when scanimage is -used multiple times (e.g. in scripts). The default is off (not set). +scanners). This option may be necessary with the 600 II N or when +.BR scanimage (1) +is used multiple times (e.g. in scripts). The default is off (not set). .PP A sample configuration file is shown below: .PP @@ -328,6 +330,7 @@ you use the scanner again, the lamp turns back on to the normal high brightness. However, the first image scanned after such a shutdown may have stripes and appear to be over-exposed. When this happens, just take another scan, and the image will be fine. + .SH FILES .TP .I @CONFIGDIR@/mustek.conf @@ -341,6 +344,7 @@ The static library implementing this backend. .I @LIBDIR@/libsane\-mustek.so The shared library implementing this backend (present on systems that support dynamic loading). + .SH ENVIRONMENT .TP .B SANE_CONFIG_DIR @@ -349,13 +353,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_MUSTEK If the library was compiled with debug support enabled, this @@ -384,7 +394,11 @@ export SANE_DEBUG_MUSTEK=4 .BR sane\-mustek_usb (5), .BR sane\-gt68xx (5), .BR sane\-plustek (5), -.BR sane\-mustek_pp (5) +.BR sane\-mustek_pp (5), +.BR sane\-ma1509 (5), +.BR scanimage (1), +.BR xscanimage (1) + .br .I @DOCDIR@/mustek/mustek.CHANGES .br diff --git a/doc/sane-mustek_pp.man b/doc/sane-mustek_pp.man index acc2f9b..8443306 100644 --- a/doc/sane-mustek_pp.man +++ b/doc/sane-mustek_pp.man @@ -97,23 +97,31 @@ systems. If that is the case for you, you can either disable ECP/EPP in your BIOS or disable it in the backend itself (see GLOBAL OPTIONS). .PP Note that the backend needs to run as root or has to have appropriate access -rights to /dev/parport* if libieee1284 support is compiled in. To allow user +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 -saned(8) and sane\-net(5)). Note also that the backend +.BR saned (8) +and +.BR sane\-net (5)). +Note also that the backend .I does not 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 -.I sane\-musteka4s2 -backend. You can only enable one of them in your dll.conf. However, you have -to enable the backend explicitly in your dll.conf, just remove the hash mark -in the line "mustek_pp". +.BR sane\-musteka4s2 (5) +backend. You can only enable one of them 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". .SH "DEVICE DEFINITION" This backend allows multiple devices being defined and configured via the -.B mustek_pp.conf +.I mustek_pp.conf file (even simultaneously, provided that they are connected to different parallel ports). Please make sure to edit this file .B before @@ -155,8 +163,11 @@ can be different for different Linux kernel versions. For instance, if you are using a Kernel 2.2.x or better and you have only one parallel port, this port is named lp0 regardless of the base address. However, this backend requires the base address of your port. If you are not sure which -port your scanner is connected to, have a look at your /etc/conf.modules, -/etc/modules.conf and/or /proc/ioports. +port your scanner is connected to, have a look at your +.IR /etc/conf.modules , +.I /etc/modules.conf +and/or +.IR /proc/ioports . .PP If you are unsure which port to use, you can use the magic value .BR * @@ -202,13 +213,13 @@ scanner Mustek_600IIIEP * ccd300 If in doubt which port you have to use, or whether your scanner is detected at all, you can use -.B sane\-find\-scanner \-p +.I sane\-find\-scanner \-p to probe all configured ports. .SH CONFIGURATION .PP The contents of the -.B mustek_pp.conf +.I mustek_pp.conf file is a list of device definitions and device options that correspond to Mustek scanners. Empty lines and lines starting with a hash mark (#) are ignored. Options have the following format: @@ -362,8 +373,12 @@ option top 56 .SH GLOBAL OPTIONS .PP -You can control the overall behaviour of the mustek_pp backend by global -options which precede any scanner definition in the mustek_pp.conf file. +You can control the overall behaviour of the +.B sane-\mustek_pp +backend by global +options which precede any scanner definition in the +.I mustek_pp.conf +file. .sp Currently, there is only one global option: @@ -400,13 +415,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_MUSTEK_PP If the library was compiled with debug support enabled, this @@ -442,7 +463,12 @@ level debug output .EE .SH "SEE ALSO" -sane(7), sane\-mustek(5), sane\-net(5), saned(8), sane\-find\-scanner(1) +.BR sane (7), +.BR sane\-mustek (5), +.BR sane\-net (5), +.BR saned (8), +.BR sane\-find\-scanner (1), +.BR scanimage (1) .TP For latest bug fixes and information see @@ -454,15 +480,18 @@ For additional information on the CIS driver, see .SH AUTHORS .nf -Jochen Eisinger <jochen at penguin\-breeder dot org> -Eddy De Greef <eddy_de_greef at scarlet dot be> +Jochen Eisinger +.RI < "jochen at penguin\-breeder dot org" > +Eddy De Greef +.RI < "eddy_de_greef at scarlet dot be" > .fi .SH BUGS Too many... please send bug reports to .I sane\-devel@alioth-lists.debian.net (note that you have to subscribe first to the list before you can send -emails... see http://www.sane\-project.org/mailing\-lists.html) +emails... see +.IR http://www.sane\-project.org/mailing\-lists.html ). .SH BUG REPORTS If something doesn't work, please contact us (Jochen for the CCD scanners, @@ -471,17 +500,24 @@ your scanner to be able to help you... .TP .I SANE version -run "scanimage \-V" to determine this +Run +.I scanimage \-V +to determine this. .TP .I the backend version and your scanner hardware -run "SANE_DEBUG_MUSTEK_PP=128 scanimage \-L" as root. If you don't get any output -from the mustek_pp backend, make sure a line "mustek_pp" is included into -your @CONFIGDIR@/dll.conf. +Run +.I SANE_DEBUG_MUSTEK_PP=128 scanimage \-L +as root. If you don't get any output from the +.BR sane\-mustek_pp +backend, make sure a line "mustek_pp" is included into your +.IR @CONFIGDIR@/dll.conf . If your scanner isn't detected, make sure you've defined the right port address -in your mustek_pp.conf. +in your +.IR mustek_pp.conf . .TP -.I the name of your scanner/vendor -also a worthy information. Please also include the optical resolution and lamp type of your scanner, both can be found in the manual of your scanner. +.I the name of your scanner/vendor also a worthy information. Please also include the +optical resolution and lamp type of your scanner, both can be found in the manual of +your scanner. .TP .I any further comments if you have comments about the documentation (what could be done better), or you diff --git a/doc/sane-mustek_usb.man b/doc/sane-mustek_usb.man index a70ad5e..cea9e36 100644 --- a/doc/sane-mustek_usb.man +++ b/doc/sane-mustek_usb.man @@ -140,13 +140,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_MUSTEK_USB If the library was compiled with debug support enabled, this @@ -186,7 +192,8 @@ export SANE_DEBUG_MUSTEK_USB=4 .I http://www.meier\-geinitz.de/sane/mustek_usb\-backend/ .SH AUTHOR -Henning Meier-Geinitz <henning@meier\-geinitz.de> +Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de > .br This backend is based on the Mustek 1200ub backend from Mustek, maintained by Tom Wang. diff --git a/doc/sane-mustek_usb2.man b/doc/sane-mustek_usb2.man index dab26dc..2ad7b24 100644 --- a/doc/sane-mustek_usb2.man +++ b/doc/sane-mustek_usb2.man @@ -19,14 +19,15 @@ the scan area. If you own a scanner other than the ones listed on the mustek_usb2 homepage that works with this backend, please let me know this by sending the scanner's exact model name and the USB vendor and device ids (e.g. from -.I sane\-find\-scanner +.BR sane\-find\-scanner (1) or syslog) to me. Even if the scanner's name is only slightly different from the models already listed as supported, please let me know. .PP .SH LIBUSB ISSUES Please use libusb-0.1.8 or later. Without libusb or with older libusb versions all kinds of trouble can be expected. The scanner should be found by -sane\-find\-scanner without further actions. For setting permissions and general +.BR sane\-find\-scanner (1) +without further actions. For setting permissions and general USB information looks at .BR sane\-usb (5). .PP @@ -56,7 +57,9 @@ export SANE_DEBUG_MUSTEK_USB2=4 .BR sane\-ma1509 (5), .BR sane\-mustek_usb (5), .BR sane\-mustek (5), -.BR sane\-mustek_pp (5) +.BR sane\-mustek_pp (5), +.BR sane\-find\-scanner (1) + .br .I @DOCDIR@/mustek_usb2/mustek_usb2.CHANGES .br @@ -64,9 +67,14 @@ export SANE_DEBUG_MUSTEK_USB2=4 .SH AUTHOR The driver has been written Roy Zhou, Jack Xu, and Vinci Cen from -Mustek. Adjustments to SANE by Henning Meier-Geinitz. +Mustek. +.br +Adjustments to SANE by Henning Meier-Geinitz. .SH BUGS Please contact me if you find a bug or missing feature: -<henning@meier\-geinitz.de>. Please send a debug log if your scanner isn't -detected correctly (see SANE_DEBUG_MUSTEK_USB2 above). +.RI < henning@meier\-geinitz.de >. +.br +Please send a debug log if your scanner isn't detected correctly (see +.B SANE_DEBUG_MUSTEK_USB2 +above). diff --git a/doc/sane-nec.man b/doc/sane-nec.man index e36ebe9..1990c1b 100644 --- a/doc/sane-nec.man +++ b/doc/sane-nec.man @@ -11,20 +11,22 @@ considered .B alpha-quality software! In the current state it is known to work with PC-IN500/4C scanners. Another MultiReader scanner series is not supported. PC-IN -500/4C and MultiReader scanner are only sold in Japan.(except Multi -Reader PetiScan.) +500/4C and MultiReader scanner are only sold in Japan (except Multi +Reader PetiScan). For other scanners, it may or may not work. .PP The backend has the following known problems: .RS +.TP \- ColorLineart mode is not supported. -.br -\- device name is fixed to /dev/scanner +.TP +\- Device name is fixed to \fI/dev/scanner\fR .RE .PP At present, the following scanners are known to work with this backend. +.PP .RS .ft CR .nf @@ -46,6 +48,7 @@ The static library implementing this backend. .I @LIBDIR@/libsane\-nec.so The shared library implementing this backend (present on systems that support dynamic loading). + .SH ENVIRONMENT .TP .B SANE_DEBUG_NEC @@ -53,7 +56,10 @@ 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. + .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5) + .SH AUTHORS Kazuya Fukuda diff --git a/doc/sane-net.man b/doc/sane-net.man index 5cf0481..0f62684 100644 --- a/doc/sane-net.man +++ b/doc/sane-net.man @@ -44,10 +44,10 @@ isn't one of the options listed below will be treated as an host name. .TP .B connect_timeout = nsecs Timeout (in seconds) for the initial connection to the -.I saned +.BR saned (8) server. This will prevent the backend from blocking for several minutes trying to connect to an unresponsive -.I saned +.BR saned (8) host (network outage, host down, ...). The environment variable .B SANE_NET_TIMEOUT can also be used to specify the timeout at runtime. @@ -123,13 +123,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_NET_HOSTS A colon-separated list of host names or IP addresses to be contacted by this @@ -137,7 +143,7 @@ backend. .TP .B SANE_NET_TIMEOUT Number of seconds to wait for a response from the -.I saned +.BR saned (8) server for the initial connection request. .TP .B SANE_DEBUG_NET @@ -146,9 +152,15 @@ 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. .SH BUGS -If saned has timed out, the net backend may loop with authorization requests. +If +.BR saned (8) +has timed out, the net backend may loop with authorization requests. + .SH "SEE ALSO" -sane(7), saned(8), sane\-dll(5), scanimage(1) +.BR sane (7), +.BR saned (8), +.BR sane\-dll (5), +.BR scanimage (1) .I http://www.penguin-breeder.org/?page=sane\-net .SH AUTHOR diff --git a/doc/sane-niash.man b/doc/sane-niash.man index 8e14b76..58c798b 100644 --- a/doc/sane-niash.man +++ b/doc/sane-niash.man @@ -1,9 +1,8 @@ -.\" $Id$ .TH sane\-niash 5 "14 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" .IX sane\-niash .SH NAME -sane\-niash \- SANE backend for scanners based on the NIASH chipset. +sane\-niash \- SANE backend for scanners based on the NIASH chipset .SH DESCRIPTION The @@ -76,6 +75,7 @@ export SANE_DEBUG_NIASH=255 .BR sane (7), .BR sane\-usb (5) .br -http://www.sourceforge.net/projects/hp3300backend +.I http://www.sourceforge.net/projects/hp3300backend .SH AUTHOR -Bertrik Sikken <bertrik@zonnet.nl> +Bertrik Sikken +.RI < bertrik@zonnet.nl > diff --git a/doc/sane-p5.man b/doc/sane-p5.man index 1c21f12..dd1db03 100644 --- a/doc/sane-p5.man +++ b/doc/sane-p5.man @@ -52,15 +52,12 @@ You can rename any device using the option. This option apply to the last port option. .SH "CONFIGURATION" -Please make sure to edit dll.conf +Please make sure to edit +.I dll.conf .B before you use the backend, since this backend isn't enabled by default. .PP -.PP - - - .SH "FILES" .TP .I @CONFIGDIR@/p5.conf @@ -83,13 +80,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_P5 If the library was compiled with debug support enabled, this @@ -114,22 +117,16 @@ level debug output 128 scanned/calibration data .fi .ft R -.RE -.PP -.TP -.PP -.RS -.ft CR -.nf -.PP - -.PP .SH "SEE ALSO" -sane(7), sane\-net(5), saned(8) +.BR sane (7), +.BR sane\-net (5), +.BR saned (8), +.BR scanimage (1) .SH "AUTHOR" -St\['e]phane Voltz <stef.dev@free.fr> +St\['e]phane Voltz +.RI < stef.dev@free.fr > .SH "CREDITS" Support for the Prima PagePartner has been made possible thank to an hardware donation @@ -137,8 +134,9 @@ by S\['e]bastien Lange. .SH "BUG REPORTS" If something doesn't work mail sane-devel@alioth-lists.debian.net or submit an -issue via https://gitlab.com/sane-project/backends/issues/new with a label of -backend/p5. +issue via +.I https://gitlab.com/sane-project/backends/issues/new +with a label of backend/p5. Please give as much information as you can. .TP @@ -146,15 +144,18 @@ Please give as much information as you can. run "scanimage \-V" to determine this .TP .I the backend version and your scanner hardware -run "SANE_DEBUG_P5=255 scanimage \-L 2>log" as root. If you don't get any output -from the p5 backend, make sure a line "p5" is included into -your @CONFIGDIR@/dll.conf. +run +.I "SANE_DEBUG_P5=255 scanimage \-L 2>log" +as root. If you don't get any output from the p5 backend, make sure a line "p5" is included into +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. .TP .I the name of your scanner/vendor -also a worthy information. Please also include the optical resolution and lamp type of your scanner, both can be found in the manual of your scanner. +also a worthy information. Please also include the optical resolution and lamp type of your +scanner, both can be found in the manual of your scanner. .TP .I any further comments if you have comments about the documentation (what could be done better), or you diff --git a/doc/sane-pie.man b/doc/sane-pie.man index f2c9b93..9236286 100644 --- a/doc/sane-pie.man +++ b/doc/sane-pie.man @@ -50,9 +50,10 @@ support dynamic loading). .PP .SH SEE ALSO -sane(7) +.BR sane (7) .SH "CONTACT AND BUG-REPORTS" Please send any information and bug-reports to: .br -.B Simon Munton <simon@munton.demon.co.uk> +Simon Munton +.RI < simon@munton.demon.co.uk > diff --git a/doc/sane-pieusb.man b/doc/sane-pieusb.man index e38e8e1..f52b844 100644 --- a/doc/sane-pieusb.man +++ b/doc/sane-pieusb.man @@ -45,15 +45,23 @@ detection and re-orientation when scanning multiple slides. You have to put all slides into one orientation first ! .SH "DIRT REMOVAL" -If available, pieusb supports infrared scans for dirt detection and +If available, +.B sane\-pieusb +supports infrared scans for dirt detection and removal. This must be enabled via the 'Clean image' setting. .SH "KNOWN PROBLEMS" -The pieusb backend supports dirt removal based on infrared scan +The +.B sane\-pieusb +backend supports dirt removal based on infrared scan information. Since SANE does not provide post-processing in the -backend, pieusb does the scanning and dirt removal during the setup +backend, +.B sane\-pieusb +does the scanning and dirt removal during the setup phase. The 'scan' phase is only used to transfer the completed image. -Therefore pieusb does not multi-thread making a typical frontend +Therefore +.B sane\-pieusb +does not multi-thread making a typical frontend appear as 'blocked'. Also cancel requests are only honored between scans. @@ -99,12 +107,13 @@ support dynamic loading). .PP .SH SEE ALSO -sane(7) +.BR sane (7) .SH "CONTACT AND BUG-REPORTS" Please send any information and bug-reports to: .br -.B Klaus Kämpf <kkaempf@suse.com> +Klaus Kämpf +.RI < kkaempf@suse.com > .SH AUTHORS The pieusb backend is based on work by Jan Vleeshouwers, Michael diff --git a/doc/sane-pint.man b/doc/sane-pint.man index 1a59608..b6dd181 100644 --- a/doc/sane-pint.man +++ b/doc/sane-pint.man @@ -9,7 +9,7 @@ library implements a SANE (Scanner Access Now Easy) backend that provides generic access to hand-held and flatbed scanners using the PINT (PINT Is Not Twain) device driver. The PINT driver is being actively developed on the OpenBSD platform, and has been ported to a -few other *nix-like operating systems. +few other *NIX-like operating systems. .PP PINT is designed to provide an .BR ioctl (2) @@ -22,8 +22,9 @@ If have successfully used the PINT driver with your scanner, but it does not work using this SANE backend, please let us know. To do this, send a mail with the relevant information for your scanner to .IR sane\-devel@alioth-lists.debian.net . -Have a look at http://www.sane\-project.org/mailing\-lists.html concerning subscription -to sane\-devel. +Have a look at +.I http://www.sane\-project.org/mailing\-lists.html +concerning subscription to sane\-devel. .SH "DEVICE NAMES" This backend expects device names of the form: @@ -76,21 +77,29 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.BR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_PINT 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. + .SH SEE ALSO -sane(7) +.BR sane (7) + .SH AUTHOR Gordon Matzigkeit, adapted from existing backends written by David Mosberger. diff --git a/doc/sane-pixma.man b/doc/sane-pixma.man index 87aadd4..bebe485 100644 --- a/doc/sane-pixma.man +++ b/doc/sane-pixma.man @@ -105,7 +105,9 @@ Feedback in the sane\-devel mailing list welcome. .RS PIXMA E400, E460, E470, E480, E500, E560, E600, E610 .br -PIXMA E3100, E3300, E4200 +PIXMA E3100, E3300, E3400, E4200 +.br +PIXMA G2020, G2060, G3020, G3060, G7000, G7080 .br PIXMA MG4100, MG6500, MG6600, MG6800, MG6900, MG8100 .br @@ -113,19 +115,21 @@ PIXMA MP375R, MP493, MP740 .br PIXMA MX320, MX390, MX430, MX450, MX490, MX710 .br -PIXMA G3000, G3010, G4010, G6000, G6080, G7000, GM4000 +PIXMA G3000, G3010, G4010, G6000, G6080, G7000, GM4000, GM4080 +.br +PIXMA TR7500, TR7530, TR7600, TR8500, TR8530, TR8580, TR8600 .br -PIXMA TR7500, TR7530, TR8500, TR8530, TR8580, TR9530 +PIXMA TR8630, TR9530 .br -PIXMA TS6000, TS6130, TS6180, TS6230, TS6280, TS6300, TS6330 +PIXMA TS3400, TS5100, TS6000, TS6130, TS6180, TS6230, TS6280, TS6300 .br -PIXMA TS6380, TS7330, TS8100, TS8130, TS8180, TS8230, TS8280 +PIXMA TS6330, TS6330, TS6380, TS6400, TS7330, TS7400, TS7430, TS8100 .br -PIXMA TS8300, TS8330, TS8380, TS9000, TS9100, TS9180, TS9500 +PIXMA TS8130, TS8180, TS8230, TS8280, TS8300, TS8330, TS8380, TS9000 .br -PIXMA TS9580 +PIXMA TS9100, TS9180, TS9500, TS9580 .br -PIXUS MP5, XK50, XK60, XK70, XK80 +PIXUS MP5, XK50, XK60, XK70, XK80, XK90 .br imageCLASS MF720, MF810/820, MF5630, MF5650, MF5750, MF8170c .br @@ -179,10 +183,13 @@ 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). Users feedback is essential to help improve features and performances. .SH OPTIONS -Besides "well-known" options (e.g. resolution, mode etc.) pixma backend also +Besides "well-known" options (e.g. resolution, mode etc.) +.Bsane\-pixma +backend also provides the following options, i.e. the options might change in the future. .br -The button status can be polled i.e. with 'scanimage \-A'. +The button status can be polled i.e. with +.I scanimage \-A. .br Button scan is disabled on MAC OS X due to darwin libusb not handling timeouts in usb interrupt reads, but may work when using the network protocol. @@ -216,7 +223,7 @@ and .I button\-2. The .B sane\-pixma -no longer requires this option to be used: if no fresh data is available, it +backend no longer requires this option to be used: if no fresh data is available, it will be now requested automatically from the scanner. This option is left for backward compatibility reasons. .TP @@ -228,7 +235,7 @@ as target. .TP .I original (read only) Returns the value of the type or size of original to be scanned -if the scanner provides that data. Known values of type: 1 = document, 2 = foto, +if the scanner provides that data. Known values of type: 1 = document, 2 = photo, 5 = film. Known values of size: 1 = A4, 2 = Letter, 8 = 10x15, 9 = 13x18, b = auto. Not all scanners can provide this data. .TP @@ -278,10 +285,12 @@ The file contains an optional list of networked scanners using the BJNP or MFNP (See below for datails on networking support for scanners). Normally 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 getifaddrs() function) you also may need +interfaces (i.e. it does not support the +.BR getifaddrs () +qfunction) you also may need to add your scanner here as well. .PP -.I Scanners shall be listed in the configuration file as follows: +Scanners shall be listed in the configuration file as follows: .PP .RS .I <method>://<host>[:port][/timeout=<value>] @@ -310,7 +319,7 @@ More globally applicable timeouts can be set using the bjnp-timeout parameter as .PP A timeout defined using bjnp-timeout will apply to the following scanner definitions in the file. If required the bjnp-timeout setting -can be defined multiple times, where each settng will apply only to the scanners that +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. If not explicitly set, the default 1000ms setting will apply. .PP @@ -318,7 +327,7 @@ Setting timeouts should only be required in exceptional cases. .PP .RE .PP -If so desired networking can be disbled as follows: +If so desired networking can be disabled as follows: .RS .IP - If the first non-commented line contains @@ -328,16 +337,19 @@ 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. Explicitely defined network scanners will still be probed. +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 -The pixma backend supports network scanners using the so called Canon BJNP +The +.B sane\-pixma +backend supports network scanners using the so called Canon BJNP and MFNP protocols. .PP Canon seems to be dropping support for these protocols in recent scanners. To verify if your scanner supports one of these protocols, check the content of -the _scanner._tcp service entry in mDNS/DNS-SD (using for example avahi-discover). +the _scanner._tcp service entry in mDNS/DNS-SD (using for example +.BR avahi-discover (1)). If that does not list port 8610 or 8612 your scanner probably does not support the mfmp or bjnp protols. .PP @@ -345,20 +357,27 @@ Both IPv4 and IPv6 are supported, but IPv6 is as yet untested with MFNP. Please report your results on the mailing list. .PP Configuration is normally not required. -The pixma backend will auto-detect your scanner if it is within +The +.B sane\-pixma +backend will auto-detect your scanner if it is within the same subnet as your computer if your OS does support this. .PP -If your scanner can not be auto-detected, you can add it to the pixma +If your scanner can not be auto-detected, you can add it to the +.B sane\-pixma configuration file (see above). .SH FIREWALLING FOR NETWORKED SCANNERS -The sane pixma backend communicates with port 8610 for MFNP or port 8612 +The +.B sane\-pixma +backend communicates with port 8610 for MFNP or port 8612 for BJNP on the scanner. So you will have to allow outgoing traffic TO port 8610 or 8612 on the common subnet for scanning. .PP -Scanner detection is slightly more complicated. The pixma backend sends +Scanner detection is slightly more complicated. The +.B sane\-pixma +backend sends a broadcast on all direct connected subnets it can find (provided your OS -allows for enumeration of all netowrk interfaces). The broadcast is sent FROM +allows for enumeration of all network interfaces). The broadcast is sent FROM port 8612 TO port 8610 or 8612 on the broadcast address of each interface. The outgoing packets will be allowed by the rule described above. .PP @@ -374,7 +393,8 @@ So in short: open the firewall for all traffic from your computer to port AND to port 8612 (for both BJNP and MFNP) to your computer. .PP With the firewall rules above there is no need to add the scanner to the -pixma.conf file, unless the scanner is on a network that is not directly +.I pixma.conf +file, unless the scanner is on a network that is not directly connected to your computer. .SH ENVIRONMENT .TP @@ -429,21 +449,31 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .SH "SEE ALSO" .BR sane (7), .BR sane\-dll (5), .BR scanimage (1), +.BR scanadf (1), .BR gamma4scanimage (1), +.BR getifaddrs (3) .PP In case of trouble with a recent Pixma model, try the latest code for -the pixma backend, available in the Sane git repository at: +the +.B sane\-pixma +backend, available in the Sane git repository at: .br .I https://gitlab.com/sane-project/backends.git .PP diff --git a/doc/sane-plustek.man b/doc/sane-plustek.man index 2df85b6..c043072 100644 --- a/doc/sane-plustek.man +++ b/doc/sane-plustek.man @@ -11,7 +11,7 @@ provides access to USB flatbed scanners based on National Semiconductor Merlin chipsets (LM9831, 9832 and 9833). If you're looking for parallel-port support for Plustek scanner please refer to the -.B sane\-plustek_pp +.BR sane\-plustek_pp (5) backend. .SH "SUPPORTED DEVICES" @@ -184,12 +184,12 @@ Strobe XP100 LM9833 600x1200dpi 48bit 512Kb 0x0427 .SH "OTHER PLUSTEK SCANNERS" For parallelport device support see the -.B plustek_pp +.BR sane\-plustek_pp (5) backend. .br The SCSI scanner OpticPro 19200S is a rebadged Artec AM12S scanner and is supported by the -.B Artec +.BR sane\-artec (5) backend. .br Only the National Semiconductor LM983[1/2/] based devices of Plustek @@ -210,13 +210,14 @@ UT12 P98003 u12 .fi .ft R For a more complete and up to date list see: -.B http://www.sane\-project.org/sane\-supported\-devices.html +.IR http://www.sane\-project.org/sane\-supported\-devices.html . .SH "CONFIGURATION" To use your scanner with this backend, you need at least two entries in the configuration file .I @CONFIGDIR@/plustek.conf .RS +.PP .I [usb] vendor-id product-id .br .I device /dev/usbscanner @@ -279,7 +280,7 @@ m/PID | 0x1000 | 0x1001 option invertNegatives b .RS .I b -0 --> do not invert the picture during negativ scans, +0 --> do not invert the picture during negative scans, .br 1 --> invert picture .RE @@ -289,7 +290,9 @@ option cacheCalData b .I b 0 --> do not save calibration results, .br -1 --> save results of calibration in ~/.sane/ directory +1 --> save results of calibration in +.I ~/.sane/ +directory .RE .PP option altCalibration b @@ -415,9 +418,9 @@ See the plustek.conf file for examples. You have to make sure, that the USB subsystem is loaded correctly and you have access to the device-node. For more details see -.B sane\-usb (5) +.BR sane\-usb (5) manpage. You might use -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) to check that you have access to your device. .PP .B Note: @@ -445,13 +448,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_PLUSTEK If the library was compiled with debug support enabled, this @@ -466,6 +475,9 @@ export SANE_DEBUG_PLUSTEK=10 .BR sane\-usb (5), .BR sane\-u12 (5), .BR sane\-gt68xx (5), +.BR sane-\mustek_pp (5), +.BR sane\-find\-scanner (1), +.BR scanimage (1), .br .I @DOCDIR@/plustek/Plustek-USB.changes @@ -478,14 +490,16 @@ Additional info and hints can be obtained from our .br Mailing-List archive at: .br -.B http://www.sane\-project.org/mailing\-lists.html +.I http://www.sane\-project.org/mailing\-lists.html .PP To obtain debug messages from the backend, please set the environment-variable -.I SANE_DEBUG_PLUSTEK -before calling your favorite scan-frontend (i.e. scanimage). +.B SANE_DEBUG_PLUSTEK +before calling your favorite scan-frontend (i.e. +.BR scanimage (1)), i.e.: + .br -.B i.e.: export SANE_DEBUG_PLUSTEK=20 ; scanimage +.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, diff --git a/doc/sane-plustek_pp.man b/doc/sane-plustek_pp.man index 3d70971..e225c95 100644 --- a/doc/sane-plustek_pp.man +++ b/doc/sane-plustek_pp.man @@ -11,7 +11,9 @@ provides access to Plustek ASIC 9600[1/3] and P9800[1/3] based parallel port flatbed scanners. The access of the scanner is either done directly by the backend or via kernel module, called pt_drv which can be created out of -the plustek_pp backend code \- see also section +the +.B sane\-plustek_pp +backend code \- see also section .B "BUILDING THE KERNEL MODULE" for further information. @@ -136,12 +138,13 @@ See this file for examples. .SH "CONFIGURATION" .PP -This section describes the backends' configuration file entries. +This section describes the backend's configuration file entries. The file is located at: .I @CONFIGDIR@/plustek_pp.conf .PP For a proper setup, you will need at least two entries: .RS +.PP .I [direct] .br .I device 0x378 @@ -227,32 +230,31 @@ Primax 4800Direct 30bit override (works if OP4830 has been detected) .RE .PP -See the plustek_pp.conf file for examples. +See the +.I plustek_pp.conf +file for examples. .PP .SH "BUILDING THE KERNEL MODULE" -As mentioned before, the plustek_pp backend code can also -be compiled and installed as linux kernel module. To do so, +As mentioned before, the +.B sane\-plustek_pp +backend code can also be compiled and installed as linux kernel module. To do so, you will need the source-files of this sane\-backend installation. Unpack this tar-ball and go to the directory: -.br -.I sane\-backends/doc/plustek -.br +.IR sane\-backends/doc/plustek . Within this directory, you should find a script called: -.br -.I MakeModule.sh -.br +.IR MakeModule.sh . Now if your Linux kernelsources are installed correctly, it should be possible to build, install and load the module -.B pt_drv. +.BR pt_drv . .B Please note, that the kernelsources need to be configured correctly. Refer to your distributions manual on how this is done. As root user, try -.br +.PP .I ./MakeModule.sh -.br +.PP the script will try and get all necessary information about your running kernel and will lead you through the whole installation process. @@ -264,11 +266,12 @@ superuser. .SH "KERNEL MODULE SETUP" The configuration of the kernel module is done by providing some or more options found below to the kernel module at -load time. This can be done by invoking insmod with the -appropriate parameters or appending the options to the file -.B /etc/modules.conf (kernel < 2.6.x) +load time. This can be done by invoking +.BR insmod (8) +with the appropriate parameters or appending the options to the file +.I /etc/modules.conf (kernel < 2.6.x) or -.B /etc/modprobe.conf (kernel >= 2.6.x) +.I /etc/modprobe.conf (kernel >= 2.6.x) .PP .B The Options: @@ -360,21 +363,27 @@ OP4830 has been detected) .RE .PP Sample entry for file -.B "/etc/modules.conf" -: -.br -.I alias char\-major\-40 pt_drv +.IR /etc/modules.conf : +.PP +.RS +alias char\-major\-40 pt_drv .br -.I pre-install pt_drv modprobe -k parport +pre-install pt_drv modprobe -k parport .br -.I options pt_drv lampoff=180 warmup=15 port=0x378 lOffonEnd=0 mov=0 slowIO=0 forceMode=0 +options pt_drv lampoff=180 warmup=15 port=0x378 lOffonEnd=0 mov=0 slowIO=0 forceMode=0 +.RE .PP For multidevice support, simply add values separated by commas to the different options -.br -.I options pt_drv port=0x378,0x278 mov=0,4 slowIO=0,1 forceMode=0,1 .PP -Remember to call depmod after changing /etc/conf.modules. +.RS +options pt_drv port=0x378,0x278 mov=0,4 slowIO=0,1 forceMode=0,1 +.RE +.PP +Remember to call +.BR depmod (8) +after changing +.IR /etc/conf.modules . .PP .SH "PARALLEL PORT MODES" @@ -398,7 +407,9 @@ images (parts duplicated or shifted horizontally) kill all other applications before scanning and (if sufficient memory available) disable swapping. .PP -See the plustek_pp.conf file for examples. +See the +.I plustek_pp.conf +file for examples. .PP .SH FILES @@ -428,13 +439,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_PLUSTEK_PP If the library was compiled with debug support enabled, this @@ -446,6 +463,7 @@ export SANE_DEBUG_PLUSTEK_PP=10 .SH "SEE ALSO" .BR sane (7), +.BR xscanimage (1), .br .I @DOCDIR@/plustek/Plustek\-PARPORT.changes @@ -458,14 +476,15 @@ Additional info and hints can be obtained from our .br Mailing-List archive at: .br -.B http://www.sane\-project.org/mailing\-lists.html +.I http://www.sane\-project.org/mailing\-lists.html .PP To obtain debug messages from the backend, please set the environment-variable -.I SANE_DEBUG_PLUSTEK_PP -before calling your favorite scan-frontend (i.e. xscanimage). +.B SANE_DEBUG_PLUSTEK_PP +before calling your favorite scan-frontend (i.e. +.BR xscanimage (1)), i.e.: .br -.B i.e.: export SANE_DEBUG_PLUSTEK_PP=20 ; xscanimage +.I export SANE_DEBUG_PLUSTEK_PP=20 ; xscanimage .PP The value controls the verbosity of the backend. .PP @@ -509,4 +528,4 @@ corruption or cause the sensor to hit the scan bed. .PP * The scanning speed on 600x1200 dpi models is slow. .PP -* The scanning quality of the A3I is poor +* The scanning quality of the A3I is poor. diff --git a/doc/sane-pnm.man b/doc/sane-pnm.man index bd68667..80c81fe 100644 --- a/doc/sane-pnm.man +++ b/doc/sane-pnm.man @@ -2,6 +2,7 @@ .IX sane\-pnm .SH NAME sane\-pnm \- SANE PNM image reader pseudo-backend + .SH DESCRIPTION The .B sane\-pnm @@ -15,6 +16,7 @@ This backend provides two devices called .B 0 and .BR 1. + .SH CONFIGURATION No configuration required. .SH FILES @@ -25,6 +27,7 @@ The static library implementing this backend. .I @LIBDIR@/libsane\-pnm.so The shared library implementing this backend (present on systems that support dynamic loading). + .SH ENVIRONMENT .TP .B SANE_DEBUG_PNM @@ -32,15 +35,33 @@ 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. + .SH BUGS -If the pnm backend is installed and saned is used to allow users on remote -computers to scan on the local machine, pnm files can be read by the remote -user. This is limited to the files saned can access (usually it's running as -user "sane"). All pnm files can be read if saned runs as root which isn't -recommended anyway. The pnm backend is disabled by default. If you want to use -it, enable it with configure (see configure \-\-help for details). Be sure that -only trusted users can access the pnm backend over saned. +If the +.B sane\-pnm +backend is installed and +.BR saned (8) +is used to allow users on remote +computers to scan on the local machine, PNM files can be read by the remote +user. This is limited to the files +.BR saned (8) +can access (usually it's running as +user "sane"). All PNM files can be read if +.BR saned (8) +runs as root which isn't +recommended anyway. The +.B sane\-pnm +backend is disabled by default. If you want to use it, enable it with configure (see +.I configure \-\-help +for details). Be sure that +only trusted users can access the +.B sane\-pnm +backend over +.BR saned (8). + .SH AUTHOR Andreas Beck, Gordon Matzigkeit, and David Mosberger + .SH SEE ALSO -sane(7) +.BR sane (7), +.BR saned (8) diff --git a/doc/sane-qcam.man b/doc/sane-qcam.man index 018b95f..30d2e83 100644 --- a/doc/sane-qcam.man +++ b/doc/sane-qcam.man @@ -14,7 +14,7 @@ This backend expects device names of the form: .I port .RE .PP -Where +where .I port is the I/O port address at which the device resides. This address is normally specified in hexadecimal using C syntax (e.g., 0x37b) and may @@ -64,21 +64,29 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_QCAM 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. + .SH AUTHOR David Mosberger + .SH BUGS Support is currently limited to the color version of the QuickCam. The black-and-white camera is starting to work too, but I don't @@ -88,5 +96,6 @@ like a problem due to byte-padding). .PP The program needs root-privileges since it needs to be able to access the camera's I/O ports. + .SH SEE ALSO -sane(7) +.BR sane (7) diff --git a/doc/sane-ricoh.man b/doc/sane-ricoh.man index 1452e24..4006b49 100644 --- a/doc/sane-ricoh.man +++ b/doc/sane-ricoh.man @@ -27,13 +27,15 @@ Where is the path-name for the special device that corresponds to a SCSI scanner. The special device name must be a generic SCSI device or a symlink to such a device. The program -.IR sane\-find\-scanner +.BR sane\-find\-scanner (1) helps to find out the correct device. Under Linux, such a device name could be .I /dev/sga or .IR /dev/sge , -for example. See sane\-scsi(5) for details. +for example. See +.BR sane\-scsi (5) +for details. .SH FILES .TP @@ -56,13 +58,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_RICOH If the library was compiled with debug support enabled, this @@ -73,6 +81,9 @@ Example: export SANE_DEBUG_RICOH=4 .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5), +.BR sane\-find\-scanner (1) + .SH AUTHOR Feico W. Dillema diff --git a/doc/sane-ricoh2.man b/doc/sane-ricoh2.man index ff74974..67ba042 100644 --- a/doc/sane-ricoh2.man +++ b/doc/sane-ricoh2.man @@ -29,8 +29,12 @@ support dynamic loading). .SH OPTIONS The options the backend supports can either be selected through command line -options to programs like scanimage or through GUI elements in programs like -xscanimage or xsane. +options to programs like +.BR scanimage (1) +or through GUI elements in programs like +.BR xscanimage (1) +or +.BR xsane (1). .PP The following options are supported by ricoh2: @@ -54,6 +58,11 @@ environment variable controls the debug level for this backend. Higher debug levels increase the verbosity of the output. .SH "SEE ALSO" -sane(7), sane\-usb(5) +.BR sane (7), +.BR sane\-usb (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1) + .SH AUTHOR Stanislav Yuzvinsky diff --git a/doc/sane-rts8891.man b/doc/sane-rts8891.man index de0683d..75c5ac1 100644 --- a/doc/sane-rts8891.man +++ b/doc/sane-rts8891.man @@ -23,14 +23,19 @@ The scanners that work with this backend are: .RE The options the backend supports can either be selected through -command line options to programs like scanimage or through GUI -elements in xscanimage or xsane. +command line options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +or +.BR xsane (1). .br -If you have any strange behavior, please report to the backend +If you notice any strange behavior, please report to the backend maintainer or to the SANE mailing list. Valid command line options and their syntax can be listed by using + .RS scanimage \-\-help \-d rts8891 .RE @@ -41,7 +46,7 @@ scanimage \-\-help \-d rts8891 .TP .B \-\-mode selects the basic mode of operation of the scanner valid choices are -.I R Color , +.IR "R Color" , .I Gray and .I Lineart @@ -83,24 +88,24 @@ The default value of the threshold option is 50. .SH "CONFIGURATION FILE" The configuration file -.B @CONFIGDIR@/rts8891.conf +.I @CONFIGDIR@/rts8891.conf contains the usb device ids of supported scanners (eg usb 0x043d 0x007c) and scanner configuration options. Empty lines and lines starting with a hash mark (#) are ignored. .PP The options supported are -.B allowsharing -, +.BR allowsharing , .B modelnumber . Option -.PP +.TP .B allowsharing enables or not the sharing of the scanner between multiple frontends at the same time. -.PP +.TP .B modelnumber is used to force the reported model by the backend and is only useful in the case of a scanner which NVRAM has been erased. + .RS .ft CR .nf @@ -111,7 +116,6 @@ is used to force the reported model by the backend and is only useful in the cas .ft R .RE -.PP .SH "FILES" .TP .I @LIBDIR@/libsane\-rts8891.a @@ -121,36 +125,37 @@ The static library implementing this backend. The shared library implementing this backend (present on systems that support dynamic loading). - .SH "ENVIRONMENT" .TP .B SANE_DEBUG_RTS8891 SANE_DEBUG_RTS8891_LOW SANE_DEBUG_RTS88XX_LIB If the library was compiled with debug support enabled, these -environment variables controls the debug level for this backend. E.g., +environment variables control the debug level for this backend. E.g., a value of 255 requests all debug output to be printed. Smaller levels reduce verbosity. - .SH "LIMITATIONS" Scanners of the same model exist with different sensors, due to lack of data (ie USB logs) some sensors are better supported than others. At least 75 dpi mode is working for any model. Sharing the scanner between several frontends at the same time (allowsharing option) may not work on some USB controllers. .PP -XPA is no (yet) supported. +XPA is not (yet) supported. .SH "BUGS" .br No bugs currently known. - .SH "SEE ALSO" -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) - +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1), +.BR sane (7) .SH "AUTHOR" .TP This backend has been developed by St\['e]phane Voltz. .I http://stef.dev.free.fr/sane/rts8891 + .SH "CREDITS" .TP Many thanks go to: diff --git a/doc/sane-s9036.man b/doc/sane-s9036.man index 468b44e..5065a3d 100644 --- a/doc/sane-s9036.man +++ b/doc/sane-s9036.man @@ -20,13 +20,15 @@ Where is the path-name for the special device that corresponds to a SCSI scanner. The special device name must be a generic SCSI device or a symlink to such a device. The program -.IR sane\-find\-scanner +.BR sane\-find\-scanner (1) helps to find out the correct device. Under Linux, such a device name could be .I /dev/sga or .IR /dev/sge , -for example. See sane\-scsi(5) for details. +for example. See +.BR sane\-scsi (5) +for details. .SH FILES .TP @@ -49,13 +51,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_S9036 If the library was compiled with debug support enabled, this @@ -66,6 +74,8 @@ Example: export SANE_DEBUG_S9036=4 .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5) + .SH AUTHOR Ingo Schneider diff --git a/doc/sane-sceptre.man b/doc/sane-sceptre.man index b60da27..4edb7ea 100644 --- a/doc/sane-sceptre.man +++ b/doc/sane-sceptre.man @@ -27,9 +27,15 @@ Sceptre VividScan S1200 SCSI The make of this scanner is KINPO, so other scanners from that manufacturer may also work (eg. the S600). .SH OPTIONS The options the backend supports can either be selected through command line -options to programs like scanimage or through GUI elements in xscanimage or xsane. +options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xscanimage (1) +or +.BR xsane (1). Valid command line options and their syntax can be listed by using + .RS scanimage \-\-help \-d sceptre .RE @@ -38,58 +44,73 @@ scanimage \-\-help \-d sceptre .B Scan Mode .TP -.B \-\-mode -selects the basic mode of operation of the scanner valid choices are -.I Lineart, Halftone, Gray and Color. -The Lineart and Halftone mode are black and white only (1 bit). Gray -will produce 256 levels of gray (8 bits). Color will produce a 24 bits +.B \-\-mode Lineart|Halftone|Gray|Color +Selects the basic mode of operation of the scanner. +The +.I Lineart +and +.I Halftone +mode are black and white only (1 bit). +.I Gray +will produce 256 levels of gray (8 bits). +.I Color +will produce a 24 bits color image. The scanner supports 30 bits internally but it only exports 24. .TP -.B \-\-resolution -selects the resolution for a scan. The scanner can do several +.B \-\-resolution 50..1200 +Selects the resolution for a scan. The scanner can do several resolutions between 50 and 1200. .TP -.B \-\-halftone\-pattern -selects the pattern mode that is used in Halftone mode. Valid options -are 1, 2, 3 and 4. +.B \-\-halftone\-pattern 1|2|3|4 +Selects the pattern mode that is used in +.I Halftone +mode. .TP -.B \-\-gamma\-correction -controls the scanner internal gamma correction. Valid options are -"Default", "User defined", "High density printing" "Low density -printing" and "High contrast printing". +.B \-\-gamma\-correction Default|User Defined|High Density Printing|\ +Low density printing|High contrast printing +controls the scanner internal gamma correction. .TP .B \-\-custom\-gamma -(color mode only) allows the user to specify a gamma table (see the +Allows the user to specify a gamma table (see the next 3 parameters). +.I Color +mode only. .TP .B \-\-red\-gamma\-table -(color mode only) can be used to download a user defined +Can be used to download a user defined gamma table for the red channel. The table must be 256 bytes long. +.I Color +mode only. .TP .B \-\-green\-gamma\-table -(color mode only) can be used to download a user defined +Can be used to download a user defined gamma table for the green channel. The table must be 256 bytes long. +.I Color +mode only. .TP .B \-\-blue\-gamma\-table -(color mode only) can be used to download a user defined gamma table +Can be used to download a user defined gamma table for the blue channel. The table must be 256 bytes long. +.I Color +mode only. .TP -.B \-\-threshold -sets the threshold for black and white pixels in lineart +.B \-\-threshold 0..255 +Sets the threshold for black and white pixels in +.I Lineart mode. Possible values are from 0 (darker) to 255 (lighter). .TP .B \-\-preview -requests a preview scan. The resolution used for that scan is 30 dpi +Requests a preview scan. The resolution used for that scan is 30 dpi and the scan area is the maximum allowed. The scan mode is user selected. The default is "no". @@ -98,13 +119,22 @@ selected. The default is "no". .TP .B \-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 by default. +control the scan area: +.B -l +sets the top left x coordinate, +.B \-t +the top left y coordinate, +.B \-x +selects the width and +.B \-y +the height of the scan area. All parameters are specified in millimeters by default. .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/sceptre.conf supports only one information: the device name to use (eg /dev/scanner). +The configuration file +.I @CONFIGDIR@/sceptre.conf +supports only one item: the device name to use +.RI "(eg " /dev/scanner ). .SH FILES @@ -136,13 +166,15 @@ enough. .SH BUGS - None known. .SH "SEE ALSO" - -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1), +.BR sane (7) .SH AUTHOR diff --git a/doc/sane-scsi.man b/doc/sane-scsi.man index 5a27555..9239250 100644 --- a/doc/sane-scsi.man +++ b/doc/sane-scsi.man @@ -11,15 +11,15 @@ appropriate backend configuration file before using SANE for the first time. For most systems, the configuration file should list the name of the generic SCSI device that the scanner is connected to (e.g., under Linux, -.B /dev/sg4 +.I /dev/sg4 or -.B /dev/sge +.I /dev/sge is such a generic SCSI device). It is customary to create a symlink from -.B /dev/scanner +.I /dev/scanner to the generic SCSI device that the scanner is connected to. In this case, the configuration file simply lists the line -.BR /dev/scanner . +.IR /dev/scanner . For a detailed description of each backend's configuration file, please refer to the relevant backend manual page (e.g., .BR sane\-epson (5) @@ -46,7 +46,8 @@ is the SCSI model string, .I TYPE is type SCSI device type string, .I BUS -is the SCSI bus number (named "host" in /proc/scsi/scsi), +is the SCSI bus number (named "host" in +.IR /proc/scsi/scsi ), .I CHANNEL is the SCSI channel number, .I ID @@ -56,8 +57,9 @@ is the logical unit number of the scanner device. The first two fields are strings which must be enclosed in double-quotes if they contain any whitespace. The remaining four fields are non-negative integer numbers. The correct values for these fields can be found by using operating system -specific tools, e.g. for Linux by looking at the output of the command "cat -/proc/scsi/scsi". To simplify configuration, a field's value can be replaced +specific tools, e.g. for Linux by looking at the output of the command +.IR "cat /proc/scsi/scsi" . +To simplify configuration, a field's value can be replaced with an asterisk symbol (``*''). An asterisk has the effect that any value is allowed for that particular field. This can have the effect that a single scsi-line matches multiple devices. When this happens, each matching device @@ -103,11 +105,13 @@ form. This is explained below in the relevant platform-specific section. .PP When using a SCSI scanner, ensure that the access permission for the generic SCSI device is set appropriately. We recommend to add a group -"scanner" to /etc/group which contains all users that should have +"scanner" to +.I /etc/group +which contains all users that should have access to the scanner. The permission of the device should then be set to allow group read and write access. For example, if the scanner is at generic SCSI device -.BR /dev/sg0 , +.IR /dev/sg0 , then the following two commands would set the permission correctly: .PP .RS @@ -118,7 +122,7 @@ $ chmod 660 /dev/sg0 .RE .PP When your system uses the device filesystem (devfs), you have to edit -.BR /etc/devfs/perms. +.BIR /etc/devfs/perms. There you should search the line .PP .RS @@ -133,10 +137,13 @@ REGISTER ^sg4 PERMISSIONS root.scanner 0660 .PP .SH FREEBSD INFO Auto-configuration using the "scsi *" lines in the config files only works if -the user running the frontend has read/write access to /dev/xpt0. Instead, you -can also set a link +the user running the frontend has read/write access to +.IR /dev/xpt0 . +Instead, you can also set a link .I /dev/scanner -to the appropriate /dev/uk device. +to the appropriate +.I /dev/uk +device. .RS .TP Adaptec AHA1542CF @@ -162,11 +169,13 @@ Works on FreeBSD 2.2.5R and 3.0 using the driver, provided that Plug-and-Play support is disabled on the card. If there are no .I uk -devices, just do a ``sh MAKEDEV uk0'' in the -.B /dev +devices, just do a +.I sh MAKEDEV uk0 +in the +.i /dev directory. The scanner should then be accessible as -.B /dev/uk0 if it was probed -during boot. +.I /dev/uk0 +if it was probed during boot. .TP Tekram DC390 Reported to work fine under FreeBSD 2.2.2R with the @@ -176,23 +185,28 @@ driver. .SH LINUX INFO First, make sure your kernel has SCSI generic support enabled. In -``make xconfig'', this shows up under ``SCSI support->SCSI generic -support''. +.IR "make xconfig" , +this shows up under ``SCSI support->SCSI generic support''. .PP To keep scanning times to a minimum, it is strongly recommended to use a large buffer size for the generic SCSI driver. From SG driver version 2.0 on, the maximum buffer size can be changed at program run time, and there is no restriction in size. This driver version is part of the Linux kernels from version 2.2.7 on. If the new SG driver is available some backends -(e.g. sane\-umax, sane\-mustek, sane\-sharp) automatically request larger scsi -buffers. If a backend does not automatically request a larger scsi buffer, set +(e.g. +.BR sane\-umax (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 the environment variable .B SANE_SG_BUFFERSIZE 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 http://www.torque.net/sg. +issues of the SG driver, see +.I http://www.torque.net/sg. .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 @@ -209,7 +223,7 @@ necessary with older Linux kernels. .PP A common issue with SCSI scanners is what to do when you booted -the system while the scanner was turned off? In such a case, the +the system while the scanner was turned off. In such a case, the scanner won't be recognized by the kernel and SANE won't be able to access it. Fortunately, Linux provides a simple mechanism to probe a SCSI device on demand. Suppose you have a scanner connected @@ -232,7 +246,9 @@ list isn't complete, usually any SCSI adapter supported by Linux should work. .RS .TP Acard/Advance SCSI adapters -Some old versions of the kernel driver (atp870u.c) cut the inquiry information. +Some old versions of the kernel driver +.RI ( atp870u.c ) +cut the inquiry information. Therefore the scanner couldn't be detected correctly. Use a current kernel. .TP Adaptec AHA-1505/AHA-1542/AHA-2940 @@ -259,12 +275,16 @@ NCR/Symbios 53c400/53c400a or Domex DTC3181E/L/LE (DTCT436/436P) ISA SCSI card This card is supplied by Mustek (and other vendors). It's supported since Linux 2.2. The SCSI cards are supported by the module g_NCR5380. It's necessary to tell the kernel the io port and type of card. Example for a -53c400a: ``modprobe g_NCR5380 ncr_addr=0x280 ncr_53c400a=1''. Once the kernel -detects the card, it should work all right. However, while it should work, do -not expect good performance out of this card---it has no interrupt line and -therefore while a scan is in progress, the system becomes almost unusable. -You may change the values of the USLEEP macros in drivers/scsi/g_NCR5380.c. -Some documentation is in this file and NCR5380.c. +53c400a: +.I "modprobe g_NCR5380 ncr_addr=0x280 ncr_53c400a=1" . +Once the kernel detects the card, it should work all right. +However, while it should work, do not expect good performance out of this +card---it has no interrupt line and therefore while a scan is in progress, +the system becomes almost unusable. You may change the values of the USLEEP +macros in +.IR drivers/scsi/g_NCR5380.c . +Some documentation is in this file and +.IR NCR5380.c . .TP NCR/Symbios 810 For some scanners it may be necessary to disable disconnect/reconnect. To @@ -275,16 +295,22 @@ both if you have trouble. For Linux kernels before 2.0.33 it may be necessary to increase the SCSI timeout. The default timeout for the Linux kernels before 2.0.33 is 10 seconds, which is way too low when scanning large area. If you get messages -of the form ``restart (ncr dead ?)'' in your /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 ncr53c8xx.c (normally in -directory /usr/src/linux/drivers/scsi) and change the constant 10 to, say, 60 -(one minute). Then rebuild the kernel/module and try again. +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. +(normally in directory +.IR /usr/src/linux/drivers/scsi ) +and change the constant 10 to, say, 60 (one minute). +Then rebuild the kernel/module and try again. .TP Tekram DC315 -The driver can be downloaded from http://www.garloff.de/kurt/linux/dc395/. +The driver can be downloaded from +.IR http://www.garloff.de/kurt/linux/dc395/ . For some older scanners it may be necessary to disable all the more advanced -features by using e.g. modprobe dc395x_trm dc395x_trm=7,5,1,32. +features by using e.g. +.IR "modprobe dc395x_trm dc395x_trm=7,5,1,32" . .TP Tekram DC390 Version 1.11 of the Tekram driver seems to work fine mostly, except @@ -295,16 +321,17 @@ and does not suffer from the timeout problems. .SH SOLARIS, OPENSTEP AND NEXTSTEP INFO Under Solaris, OpenStep and NeXTStep, the generic SCSI device name refers to a SCSI bus, not to an individual device. For example, -.B /dev/sg0 +.I /dev/sg0 refers to the first SCSI bus. To tell SANE which device to use, append the character 'a'+target-id to the special device name. For example, the SCSI device connected to the first SCSI controller and with target-id 0 would be called -.BR /dev/sg0a , +.IR /dev/sg0a , and the device with target-id 1 on that same bus would be called -.BR /dev/sg0b, +.IR /dev/sg0b, and so on. + .SH ENVIRONMENT .TP .B SANE_DEBUG_SANEI_SCSI diff --git a/doc/sane-sharp.man b/doc/sane-sharp.man index b4453ee..3200990 100644 --- a/doc/sane-sharp.man +++ b/doc/sane-sharp.man @@ -61,260 +61,192 @@ or for example. See sane\-scsi(5) for details. .SH SCAN OPTIONS - -.B Scan Mode -(parameter +.TP .B \-\-mode -for scanimage). Possible settings: -.RS -.B Lineart +Scan Mode. Possible settings are: +.I Lineart (1 bit black & white scans), -.br -.B Gray +.I Gray (8 bit gray scale scans), -.br -.B Lineart Color -(bi-level color scans), -.br -.B Color -(8 bit RGB scans). -.RE -The default value is -.B Color. +.I Lineart Color +(bi-level color scans), and +.I Color +(8 bit RGB scans). The default value is +.I Color. -.B Halftone Pattern -(parameter +.TP .B \-\-halftone\-pattern -for scanimage). Available only for the JX-330 series scanners. +Halftone Pattern. Available only for the JX-330 series scanners. Possible settings: -.RS -.B none -.br -.B Dither Bayer -.br -.B Dither Spiral -.br -.B Dither Dispersed -.br -.B Error Diffusion -.RE +.IR none ", " "Dither Bayer" ", " "Dither Spiral" ", " "Dither Dispersed" +and +.IR "Error Diffusion" . The default value is -.B none. +.IR none . -.B Paper Source -(parameter +.TP .B \-\-source -for scanimage). This option is only available, if an automatic document -feeder or a transparency adapter is installed. Possible settings: -.RS -.B Flatbed -.br -.B Automatic Document Feeder -.br -.B Transparency Adapter -.RE +Paper Source. This option is only available if an automatic document +feeder or a transparency adapter is installed. Possible settings are: +.IR Flatbed ", " "Automatic Document Feeder" , +and +.IR "Transparency Adapter" . If an ADF or a transparency adapter is installed, using it is the default selection. -.B Custom Gamma -(parameter +.TP .B \-\-custom\-gamma -for scanimage). This option determines whether a builtin or a custom -gamma-table is used. Possible settings: -.RS -.B yes -enables custom gamma tables -.br -.B no -enables a built gamma table -.RE +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 +.I no +(enables a built gamma table). -.B Gamma -(parameter -.B \-\-Gamma -for scanimage). This option is only available, if +.TP +.B \-\-gamma +Gamma. This option is only available if .B Custom Gamma is set to -.B no. -Possible values: -.RS -.B 1.0 -.br -.B 2.2 -.RE -The default value is 2.2. (The JX-250 and JX-350 have no built in gamma -correction; for these scanner, a gamma table is downloaded to the scanner +.IR no . +Possible values are: +.IR 1.0 " or " 2.2 "." +The default value is +.IR 2.2 . +(The JX-250 and JX-350 have no built in gamma +correction; for these scanners, a gamma table is downloaded to the scanner by the backend.) -.B Gamma Table -(parameter +.TP .B \-\-gamma\-table -for scanimage). Allowed values: 0..255; 256 numbers must be defined. +Gamma Table. Allowed values: 0..255; 256 numbers must be defined. The default values are 0, 1, 2, .. 255 (i.e., gamma == 1). This table is only used for gray scale scans. -.B Red Gamma Table -(parameter +.TP .B \-\-red\-gamma\-table -for scanimage). Allowed values: 0..255; 256 numbers must be defined. +Red Gamma Table. Allowed values: 0..255; 256 numbers must be defined. The default values are 0, 1, 2, .. 255 (i.e., gamma == 1). -.B Green Gamma Table -(parameter +.TP .B \-\-green\-gamma\-table -for scanimage). Allowed values: 0..255; 256 numbers must be defined. +Green Gamma Table. Allowed values: 0..255; 256 numbers must be defined. The default values are 0, 1, 2, .. 255 (i.e., gamma == 1). -.B Blue Gamma Table -(parameter +.TP .B \-\-blue\-gamma\-table -for scanimage). Allowed values: 0..255; 256 numbers must be defined. +Blue Gamma Table. Allowed values: 0..255; 256 numbers must be defined. The default values are 0, 1, 2, .. 255 (i.e., gamma == 1). -.B Resolution -in pixel per inch (parameter +.TP .B \-\-resolution -for scanimage). Selects the resolution of the scanned image. Allowed values: -.RS -.B 30..600 -(JX-330, JX-350 and JX-610) resp. -.B 30..400 -(JX-250) -.RE +Selects the resolution of the scanned image. Allowed values: +.I 30..600 +(JX-330, JX-350 and JX-610) and +.I 30..400 +(JX-250). The default value is 150. -.B Scan Window - +.TP +.BR \-l ", " \-t ", " \-x ", " \-y +Scan Window. +Top-left x position of scan area +.RB ( \-l ), +top-left y position of scan area +.RB ( \-t ), +bottom right x position of scan area +.RB ( \-x ) +and bottom right y position of scan area +.RB ( \-y ). The possible settings depend on the scanner model and, for the JX-250 and the JX-350, also on the usage of the automatic document feeder resp. the -transparency adapter. Please refer to the values allowed by xscanimage, or -xsane. With scanimage, enter one of the following commands: +transparency adapter. Please refer to the values allowed by +.BR xscanimage (1), +or +.BR xsane (1). +With +.BR scanimage (1), +enter one of the following commands in order to see the allowed parameter values for +the scan window: .RS -.I scanimage \-d sharp \-\-source """Automatic Document Feeder""" \-\-help +scanimage \-d sharp \-\-source "Automatic Document Feeder" \-\-help -.I scanimage \-d sharp \-\-source Flatbed \-\-help +scanimage \-d sharp \-\-source Flatbed \-\-help -.I scanimage \-d sharp \-\-source """Transparency Adapter""" \-\-help +scanimage \-d sharp \-\-source "Transparency Adapter" \-\-help .RE -in order to see the allowed parameter values for the scan window. - -The scan window parameters are: - -.RS -Top-left x position of scan area (parameter -.B \-l -for scanimage); -.br -Top-left y position of scan area (parameter -.B \-t -for scanimage); -.br -bottom right x position of scan area (parameter -.B \-x -for scanimage); -.br -bottom right y position of scan area (parameter -.B \-y -for scanimage); -.RE - -.B Edge emphasis -(parameter -.B \-\-Edge emphasis -for scanimage). This option is not available for the JX-250 and the JX-350. +.TP +.B \-\-edge emphasis +Edge emphasis. This option is not available for the JX-250 and the JX-350. Possible settings: -.RS -.B None -.br -.B Middle -.br -.B Strong -.br -.B Blur -.RE +.IR None ", " Middle ", " Strong ", and " Blur . The default value is -.B None. +.IR None . -.B Threshold -(parameter +.TP .B \-\-threshold -for scanimage). Sets the threshold for black and white pixels in lineart -mode. Possible values: -.RS -.B 1..255 -.RE -The default value is -.B 128. -This option is only available in scan mode lineart. +Sets the threshold for black and white pixels in lineart mode. +Possible values are 1..255. +The default value is 128. +This option is only available in scan mode +.IR lineart . -.B Threshold Red -(parameter +.TP .B \-\-threshold-red -for scanimage). Sets the threshold for the red component of a pixel in -in lineart color scan mode. Possible values: -.RS -.B 1..255 -.RE -The default value is -.B 128. -This option is only available in scan mode color lineart. +Sets the threshold for the red component of a pixel in +in lineart color scan mode. Possible values are 1..255. +The default value is 128. +This option is only available in scan mode color +.IR lineart . -.B Threshold Green -(parameter +.TP .B \-\-threshold-green -for scanimage). Sets the threshold for the green component of a pixel in -in lineart color scan mode. Possible values: -.RS -.B 1..255 -.RE -The default value is -.B 128. -This option is only available in scan mode color lineart. +Sets the threshold for the green component of a pixel in +in lineart color scan mode. Possible values are 1..255. +The default value is 128. +This option is only available in scan mode color +.I lineart . -.B Threshold Blue -(parameter +.TP .B \-\-threshold-blue -for scanimage). Sets the threshold for the blue component of a pixel in -in lineart color scan mode. Possible values: -.RS -.B 1..255 -.RE -The default value is -.B 128. -This option is only available in scan mode color lineart. +Sets the threshold for the blue component of a pixel in +in lineart color scan mode. Possible values are 1..255. +The default value is 128. +This option is only available in scan mode color +.IR lineart . -.B Light Color -(parameter -.B \-\-LightColor -for scanimage). Sets the color of the light source. Possible values: -.RS -.B white -.br -.B red -.br -.B green -.br -.B blue -.RE +.TP +.B \-\-lightcolor +Sets the color of the light source. Possible values are +.IR white , +.IR red , +.I green +and +.IR blue . The default value is -.B white. -This option is only available in scan modes lineart color and color. +.IR white . +This option is only available in scan modes +.I "lineart color" +and +.IR color . .SH ADF USAGE -If a paper jam occurred, the maintenance cover +If a paper jam occurrs, the maintenance cover .I must be opened and closed, even if the jammed paper can be removed without opening -the maintenance cover. Otherwise, the error condition cannot be cleared. +the maintenance cover. Otherwise, the error condition will not be cleared. .SH CONFIGURATION The contents of the .I sharp.conf file is a list of options and device names that correspond to Sharp scanners. Empty lines and lines beginning with a hash mark (#) are -ignored. See sane\-scsi(5) for details about device names. +ignored. See +.BR sane\-scsi (5) +for details about device names. .PP Lines setting an option start with the key word .B option, @@ -401,7 +333,7 @@ during a scan. If this is the case, you should consider to connect the scanner to a separate SCSI adapter. .PP Slow responses by the backend to the scanner: Unfortunately, -Unix-like operating systems generally have no real time capabilities. +UNIX-like operating systems generally have no real time capabilities. Thus there is no guarantee that the backend is under any circumstances able to communicate with the scanner as fast as required. To minimize this problem, the backend should be compiled so that a separate reader process @@ -433,7 +365,7 @@ of the data is too slow, set the environment variable .B SANE_DEBUG_SHARP to 1. When a scan is finished, the backend writes the line "buffer full conditions: -.I nn" +.IR nn """ to stderr. If .I nn is zero, carriage stops are caused by too slow responses of the backend @@ -488,18 +420,22 @@ scans. This happens for every scan, in contrast to the calibration, which is done after 10 scans. (For the calibration, the carriage is also moved to the idle position.) We do not -know, if this behavior is caused by the backend, or if it is a bug in the +know if this behavior is caused by the backend, or if it is a bug in the firmware of the scanner. .PP 5. Usage of a transparency adapter (film scan unit) is supported, but not tested. .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5) + .SH AUTHORS Kazuya Fukuda, Abel Deuring + .SH CREDITS The Sharp backend is based on the Canon backend written by Helmut Koeberle .PP -Parts of this man page are a plain copy of sane\-mustek(5) by David -Mosberger-Tang, Andreas Czechanowski and Andreas Bolsch +Parts of this man page are a plain copy of +.BR sane\-mustek (5) +by David Mosberger-Tang, Andreas Czechanowski and Andreas Bolsch diff --git a/doc/sane-sm3600.man b/doc/sane-sm3600.man index 7f5c9a4..849acd0 100644 --- a/doc/sane-sm3600.man +++ b/doc/sane-sm3600.man @@ -10,7 +10,11 @@ provides access to some Microtek scanners with the Toshiba M011 custom USB chip. This backend should be considered alpha. .PP There are also backends for Microtek scanners with SCSI command set. -Refer to sane\-microtek(5) and sane\-microtek2(5) for details. +Refer to +.BR sane\-microtek (5) +and +.BR sane\-microtek2 (5) +for details. .PP At present, the following scanners are known positively to work with this backend: @@ -32,8 +36,8 @@ listed above, it may or may not work with SANE! .SH "FRONTEND OPTIONS" This backend dynamically enables the options for the frontend, -that are supported by the scanner in dependence of the scanning-mode -and other options. Not supported options are disabled. +that are supported by the scanner dependent on the scanning-mode +and other options. Unsupported options are disabled. .PP The following options are supported by the Microtek2-driver: .PP @@ -63,7 +67,8 @@ 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. To see error messages on stderr set -SANE_DEBUG_SM3600 to 1. +.B SANE_DEBUG_SM3600 +to 1. .br E.g. just say: @@ -71,11 +76,17 @@ E.g. just say: export SANE_DEBUG_SM3600=5 .SH "SEE ALSO" -sane\-microtek2(5), http://sm3600.sourceforge.net +.BR sane (7) , +.BR sane\-microtek (5), +.BR sane\-microtek2 (5) +.br +.I http://sm3600.sourceforge.net .SH AUTHOR .br -Marian Eichholz (eichholz@computer.org) +Marian Eichholz +.RI < eichholz@computer.org > .br -Glenn Ramsey (glenn@componic.com) +Glenn Ramsey +.RI < glenn@componic.com > .br diff --git a/doc/sane-sm3840.man b/doc/sane-sm3840.man index e6af3a1..58f07b0 100644 --- a/doc/sane-sm3840.man +++ b/doc/sane-sm3840.man @@ -10,10 +10,15 @@ provides access to some Microtek scanners with the SCAN08 USB chip. .PP There exist backends for Microtek scanners with SCSI command set. -Refer to sane\-microtek(5) and sane\-microtek2(5) for details. +Refer to +.BR sane\-microtek (5) +and +.BR sane\-microtek2 (5) +for details. .PP -There also exists a Microtek 3600 series driver, see sane\-sm3600(5) for -details. +There also exists a Microtek 3600 series driver, see +.BR sane\-sm3600 (5) +for details. .PP At present, the following scanners are known positively to work with this backend: @@ -31,36 +36,38 @@ Microtek ScanMaker 4800 All modes OK .PP If you own a Microtek scanner with the SCAN08 chip other than the ones listed above, it may or may not work with SANE. Feel free to contact the -backend author (earle@ziplabel.com) to report results with scanners not -on the list. +backend author +.RI ( earle@ziplabel.com ) +to report results with scanners not on the list. .SH "FRONTEND OPTIONS" .PP -The following options are supported by the sm3840-driver: -.PP +The following options are supported by the +.BR sane\-sm3840 +driver: +.TP .B \-\-mode color|gray|lineart|halftone -.br Color or grayscale mode. +.TP .B \-\-resolution 150|300|600|1200 -.br Pixels per inch for scans. +.TP .B \-\-depth 8|16 -.br Note that the least significant bits of 16bpp mode may be noise. +.TP .B \-\-brightness 1..4096 -.br Higher numbers increase brightness of returned image. +.TP .B \-\-contrast 0.1..9.9 -.br Larger numbers decrease contrast of returned image. +.TP .B \-\-lamp\-timeout 1..15 -.br Time in minutes until the lamp is turned off after a scan. .SH CONFIGURATION @@ -83,12 +90,17 @@ 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. To see error messages on stderr set -SANE_DEBUG_SM3840 to 1. +.B SANE_DEBUG_SM3840 +to 1. .SH "SEE ALSO" -sane\-microtek2(5), sane\-sm3600(5), http://www.ziplabel.com/sm3840 +.BR sane (7), +.BR sane\-microtek (5), +.BR sane\-microtek2 (5), +.BR sane\-sm3600 (5) +.br +.I http://www.ziplabel.com/sm3840 .SH AUTHOR -.br -Earle F. Philhower III (earle@ziplabel.com) -.br +Earle F. Philhower III +.RI < earle@ziplabel.com > diff --git a/doc/sane-snapscan.man b/doc/sane-snapscan.man index 6e71875..aff29a9 100644 --- a/doc/sane-snapscan.man +++ b/doc/sane-snapscan.man @@ -31,7 +31,9 @@ symlink to such a device. Under Linux, such a device name could be .I /dev/sga or .IR /dev/sge , -for example. See sane\-scsi(5) for details. +for example. See +.BR sane\-scsi (5) +for details. .P For USB scanners the devicename must contain the keyword "usb", as in .I /dev/usbscanner @@ -45,14 +47,17 @@ e.g. firmware @DATADIR@/sane/snapscan/firmware.bin .RE .PP -For further details read http://snapscan.sourceforge.net. +For further details read +.IR http://snapscan.sourceforge.net . .SH CONFIGURATION The contents of the .I snapscan.conf file is a list of device names that correspond to SnapScan scanners. Empty lines and lines starting with a hash mark (#) are -ignored. See sane\-scsi(5) on details of what constitutes a valid +ignored. See +.BR sane\-scsi (5) +on details of what constitutes a valid device name. .SH FILES @@ -76,13 +81,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_SNAPSCAN If the library was compiled with debug support enabled, this @@ -95,11 +106,11 @@ levels reduce verbosity. Man page doesn't provide much information yet. .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5), .br -http://www.cs.ualberta.ca/~charter/SnapScan/snapscan.html -.br -http://sourceforge.net/projects/snapscan/ (new development website) +.I http://sourceforge.net/projects/snapscan/ +(new development website) .SH AUTHOR Kevin Charter, Franck Schneider, Michel Roelofs, Emmanuel Blot, diff --git a/doc/sane-sp15c.man b/doc/sane-sp15c.man index 6a56a8d..f0dc72a 100644 --- a/doc/sane-sp15c.man +++ b/doc/sane-sp15c.man @@ -35,11 +35,16 @@ and to contact the author with test results. .SH CONFIGURATION A modest effort has been made to expose the standard options to the API. -This allows frontends such as xscanimage to set scanning region, +This allows frontends such as +.BR xscanimage (1) +to set scanning region, resolution, bit-depth (and color), and enable the automatic document feeder. .SH "SEE ALSO" -sane(7), sane\-scsi(5), sane\-fujitsu(5) +.BR sane (7) , +.BR sane\-scsi (5) , +.BR sane\-fujitsu (5), +.BR xscanimage (1) .br Fujitsu ScanPartner 15C OEM Manual, Doc. No. 250-0081-0 .br @@ -49,7 +54,7 @@ Fujitsu M3096GX/M3093GX/M3093DG OEM Manual, part number C150-E015...03 .SH AUTHOR Randolph Bentson -<bentson@holmsjoen.com>, +.RI < bentson@holmsjoen.com >, with credit to the unnamed author of the coolscan driver .SH LIMITATIONS @@ -63,9 +68,10 @@ I'm sure there are plenty, and not too well hidden, but I haven't seen them yet. .br Both scanners claim to have separate control -of resolution in X and Y directions. -I confess I haven't tested this yet. -I have found that xsane doesn't even display this capability. +of resolution in X and Y directions. I confess I haven't tested this yet. +I have found that +.BR xsane (1) +doesn't even display this capability. .br Threshold settings on the SP15C don't seem to affect the results of lineart mode scans. diff --git a/doc/sane-st400.man b/doc/sane-st400.man index affdf72..b93dc49 100644 --- a/doc/sane-st400.man +++ b/doc/sane-st400.man @@ -23,8 +23,9 @@ and ST600. If you own one of these scanners, or a scanner other than the ones listed above that works with this backend, please let us know by sending the scanner's model name, SCSI ID, and firmware revision to .IR sane\-devel@alioth-lists.debian.net . -Have a look at http://www.sane\-project.org/mailing\-lists.html concerning subscription -to sane\-devel. +Have a look at +.I http://www.sane\-project.org/mailing\-lists.html +concerning subscription to sane\-devel. .SH "DEVICE NAMES" This backend expects device names of the form: @@ -42,7 +43,10 @@ a device name could be .I /dev/sga or .IR /dev/sge , -for example. See sane\-scsi(5) for details. +for example. See +.BR sane\-scsi (5) +for details. + .SH CONFIGURATION The contents of the .I st400.conf @@ -66,7 +70,9 @@ scsi SIEMENS "ST 400" Scanner * * 3 0 .RE .PP In this configuration, the driver can only access the ST400 model -at SCSI ID 3 LUN 0 (see section "BUGS" below for the reason). +at SCSI ID 3 LUN 0 (see section +.B BUGS +below for the reason). To use the driver with other scanner models, add an appropriate line to the configuration file. For example, to use it with an ST800 at SCSI ID 3 LUN 0, add the line: @@ -96,13 +102,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in /etc/sane.d. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"/etc/sane.d" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_ST400 If the library was compiled with debug support enabled, this environment @@ -119,7 +131,8 @@ a ST400. It will happily accept everything that matches the configuration entries. This makes it easy to test the backend with other scanners: Just add an appropriate line to the configuration file. The configuration file as distributed (see above) only works with the ST400. Be careful: -If there is no config file at all, the backend defaults to /dev/scanner. +If there is no config file at all, the backend defaults to +.IR /dev/scanner . .PP The ST400 answers on all eight SCSI LUNs. Normally this is not a problem, as LUN support is usually disabled in SCSI drivers, but if you are seeing @@ -129,18 +142,21 @@ LUN 0 only. .SH DEBUG If you encounter a bug please set the environment variable -SANE_DEBUG_ST400 to 128 and try to regenerate the problem. Then -send me a report with the log attached. +.B SANE_DEBUG_ST400 +to 128 and try to regenerate the problem. Then send me a report with the +log attached. .PP If you encounter a SCSI bus error or trimmed and/or displaced images please -also set the environment variable SANE_DEBUG_SANEI_SCSI to 128 before sending -me the report. +also set the environment variable +.B SANE_DEBUG_SANEI_SCSI +to 128 before sending me the report. .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7), +.BR sane\-scsi (5) .br -http://www.informatik.uni-oldenburg.de/~ingo/sane/ +.I http://www.informatik.uni-oldenburg.de/~ingo/sane/ .SH AUTHOR - -Ingo Wilken <Ingo.Wilken@informatik.uni-oldenburg.de> +Ingo Wilken +.RI < Ingo.Wilken@informatik.uni-oldenburg.de > diff --git a/doc/sane-stv680.man b/doc/sane-stv680.man index 90cdf53..d4a8d3a 100644 --- a/doc/sane-stv680.man +++ b/doc/sane-stv680.man @@ -32,24 +32,32 @@ for the exact status of each camera. For startup of this backend check that if present the stv680 kernel module is removed or disabled. .br -Also before using, enable the backend by editing the /etc/sane.d/dll.conf file, -change #stv680 to stv680. +Also before using, enable the backend by editing the +.I @CONFIGDIR@/dll.conf +file, change #stv680 to stv680. -For problems with the untested cameras, you -should contact the author for that. +For problems with the untested cameras, you should contact the author for that. The options the backend supports can either be selected through -command line options to programs like scanimage or through GUI -elements in xcam. For both programs use the \-B option needed for size buffer. +command line options to programs like +.BR scanimage (1) +or through GUI elements in +.BR xcam (1). +For both programs use the +.B \-B +option needed for size buffer. Some frontends examples: + .br -xcam +.BR xcam (1) .RS xcam \-B .RE -scanimage: for writing in batch mode to a file or to a new file each time. +.BR scanimage (1): +for writing in batch mode to a file or to a new file each time: + .RS scanimage \-B \-d stv680:libusb:001:002 \-\-batch=out.ppm \-\-batch-count 5 \-\-mode "Color RGB" .RE @@ -58,11 +66,12 @@ scanimage \-B \-d stv680:libusb:001:002 \-\-batch=out%d.ppm \-\-batch-count 5 \- .RE .br -If you have any success with a camera not listed here, or if you have +If you have any success with a camera not listed here, or if you observe any strange behavior, please report to the backend maintainer or to the SANE mailing list. -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 scanimage \-\-help \-d stv680 .RE @@ -96,27 +105,27 @@ Bayer unshuffle, color correction, textline with date and time is added .B Enhancement options .TP -.B \-\-white\-level\-r +.B \-\-white\-level\-r \-32..+32 Selects what red radiance level should be considered "white", when scanning some sheets by changing the calibration value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1. .TP -.B \-\-white\-level\-g +.B \-\-white\-level\-g \-32..+32 Selects what green radiance level should be considered "white", when scanning some sheets by changing the calibration i value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1. .TP -.B \-\-white\-level\-b +.B \-\-white\-level\-b \-32..+32 Selects what blue radiance level should be considered "white", when scanning some sheets by changing the calibration value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1. .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/stv680.conf supports only one -information: the device name to use (eg usb 0x.... 0x....). - +The configuration file +.I @CONFIGDIR@/stv680.conf +supports only one item: the device name to use (eg usb 0x.... 0x....). .SH FILES .TP @@ -127,7 +136,6 @@ The static library implementing this backend. The shared library implementing this backend (present on systems that support dynamic loading). - .SH ENVIRONMENT .TP .B SANE_DEBUG_STV680 @@ -141,9 +149,7 @@ The windows TWAIN driver has many more options than this SANE backend. However they are only software adjustments. This backend only implements what the webcam can support. - .SH BUGS - .TP Plenty. Parts of this backend are still under development. 1. Some untested cameras. @@ -154,22 +160,21 @@ Plenty. Parts of this backend are still under development. .SH "SEE ALSO" - -sane\-usb(5), scanimage(1), xcam(1), sane(7) - +.BR sane(7), +.BR sane\-usb (5), +.BR scanimage (1), +.BR xcam (1) .SH AUTHORS - -Gerard Klaver http://gkall.hobby.nl/stv680-aiptek.html - - +Gerard Klaver +.I http://gkall.hobby.nl/stv680-aiptek.html .SH CREDITS - .TP Thanks to developers of the other stv680 programs: STV680 kernel module .br pencam2 program .br -libghoto2 program (camlib stv0680) +.BR libghoto2 (3) +program (camlib stv0680) diff --git a/doc/sane-tamarack.man b/doc/sane-tamarack.man index 7084924..16b1128 100644 --- a/doc/sane-tamarack.man +++ b/doc/sane-tamarack.man @@ -29,13 +29,15 @@ Where is the path-name for the special device that corresponds to a SCSI scanner. The special device name must be a generic SCSI device or a symlink to such a device. The program -.IR sane\-find\-scanner +.BR sane\-find\-scanner (1) helps to find out the correct device. Under Linux, such a device name could be .I /dev/sga or .IR /dev/sge , -for example. See sane\-scsi(5) for details. +for example. See +.BR sane\-scsi (5) +for details. .SH FILES .TP @@ -58,13 +60,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR "tmp/config" , +.IR "." , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_TAMARACK If the library was compiled with debug support enabled, this @@ -75,6 +83,9 @@ Example: export SANE_DEBUG_TAMARACK=4 .SH "SEE ALSO" -sane(7), sane\-scsi(5) +.BR sane (7) , +.BR sane\-find\-scanner (1), +.BR sane\-scsi (5) + .SH AUTHOR Roger Wolff diff --git a/doc/sane-teco1.man b/doc/sane-teco1.man index 4f4ce85..e9d9663 100644 --- a/doc/sane-teco1.man +++ b/doc/sane-teco1.man @@ -47,19 +47,27 @@ Note that the untested scanner will not be directly supported. You should contact the author for that. The TECO VM number can usually be found at the back of the scanner. It -is also part of the FCC ID. "sane\-find\-scanner \-v" will also show the -scsi inquiry, and if it is a TECO scanner, the name will be there too. +is also part of the FCC ID. +.I sane\-find\-scanner \-v +will also show the +SCSI inquiry, and if it is a TECO scanner, the name will be there too. The options the backend supports can either be selected through -command line options to programs like scanimage or through GUI -elements in xscanimage or xsane. +command line options to programs like +.BR scanimage (1) +or through GUI +elements in +.BR xscanimage (1) +or +.BR xsane (1). .br -If you have any success with a scanner not listed here, or if you have +If you have any success with a scanner not listed here, or if you notice any strange behavior, please report to the backend maintainer or to the SANE mailing list. -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 scanimage \-\-help \-d teco1 .RE @@ -68,20 +76,19 @@ scanimage \-\-help \-d teco1 .B Scan Mode .TP -.B \-\-mode -selects the basic mode of operation of the scanner valid choices are +.B \-\-mode Black & White|Grayscale|Color +Selects the basic mode of operation of the scanner valid choices are +The .I Black & White -, +mode is black and white only (1 bit). .I Grayscale -and +will produce 256 levels of gray (8 bits). .I Color -The Black & White mode is black and white only (1 bit). Grayscale -will produce 256 levels of gray (8 bits). Color will produce a 24 bits -color image. +will produce a 24 bits color image. .TP -.B \-\-resolution -selects the resolution for a scan. The scanner can do all resolutions +.B \-\-resolution 1..600 +Selects the resolution for a scan. The scanner can do all resolutions between 1 and 600, in increments of 1. @@ -90,9 +97,15 @@ between 1 and 600, in increments of 1. .TP .B \-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 by default. +Controls the scan area: +.B \-l +sets the top left x coordinate, +.B \-t +the top left y coordinate, +.B \-x +selects the width and +.B \-y +the height of the scan area. All parameters are specified in millimeters by default. .TP @@ -105,50 +118,36 @@ next 3 parameters). .TP .B \-\-red\-gamma\-table -(color mode only) can be used to download a user defined -gamma table for the red channel. The table must be 256 bytes long. +Can be used to download a user defined gamma table for the red channel. +The table must be 256 bytes long. Color mode only. .TP .B \-\-green\-gamma\-table -(color mode only) can be used to download a user defined -gamma table for the green channel. The table must be 256 bytes long. +Can be used to download a user defined gamma table for the green channel. +The table must be 256 bytes long. Color mode only. .TP .B \-\-blue\-gamma\-table -(color mode only) can be used to download a user defined gamma table -for the blue channel. The table must be 256 bytes long. - -.TP -.B \-\-dither -(Black & White only) select the dither mask to use. Possible values are -.I Line art -, -.I 2x2 -, -.I 3x3 -, -.I 4x4 bayer -, -.I 4x4 smooth -, -.I 8x8 bayer -, -.I 8x8 smooth -, -.I 8x8 horizontal -and -.I 8x8 vertical +Can be used to download a user defined gamma table for the blue channel. +The table must be 256 bytes long. Color mode only. + +.TP +.B \-\-dither Line art|2x2|3x3|4x4 bayer|4x4 smooth|8x8 bayer|8x8 smooth|8x8 horizontal|8x8 vertical +Select the dither mask to use. Black & White only. .TP .B \-\-preview -requests a preview scan. The resolution used for that scan is 22 dpi +Requests a preview scan. The resolution used is 22 dpi and the scan area is the maximum allowed. The scan mode is user selected. The default is "no". .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/teco1.conf supports only one information: the device name to use (eg /dev/scanner). +The configuration file +.I @CONFIGDIR@/teco1.conf +supports only one item: the device name to use (eg +.IR /dev/scanner ). .SH FILES @@ -177,14 +176,14 @@ implements what the scanner can support. .SH BUGS - None known. - .SH "SEE ALSO" - -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) - +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1), +.BR sane (7) .SH AUTHOR .TP diff --git a/doc/sane-teco2.man b/doc/sane-teco2.man index 4b79960..6b04290 100644 --- a/doc/sane-teco2.man +++ b/doc/sane-teco2.man @@ -18,20 +18,20 @@ The scanners that should work with this backend are: .RS .ft CR .nf - Vendor Model TECO model status ----------------------- -------------- ----------- - Mustek ScanMagic 4830S VM3575 untested - Primax Jewel 4800 VM356A good - Primax Profi 9600 VM6575 basic - Primax Profi 19200 VM6586 good - Relisys APOLLO Express 3 VM356A basic - Relisys APOLLO Express 6 VM6565 good - Relisys APOLLO Express 12 ? untested - Relisys AVEC II S3 VM3564 good - Relisys AVEC Super 3 VM3575 basic - Relisys SCORPIO Pro VM6575 good - Relisys SCORPIO Pro-S VM6586 untested - Relisys SCORPIO Super 3 VM3575 good + Vendor Model TECO model status +--------------------------- -------------- ----------- + Mustek ScanMagic 4830S VM3575 untested + Primax Jewel 4800 VM356A good + Primax Profi 9600 VM6575 basic + Primax Profi 19200 VM6586 good + Relisys APOLLO Express 3 VM356A basic + Relisys APOLLO Express 6 VM6565 good + Relisys APOLLO Express 12 ? untested + Relisys AVEC II S3 VM3564 good + Relisys AVEC Super 3 VM3575 basic + Relisys SCORPIO Pro VM6575 good + Relisys SCORPIO Pro-S VM6586 untested + Relisys SCORPIO Super 3 VM3575 good .fi .ft R .RE @@ -48,15 +48,24 @@ The TECO VM number can usually be found at the back of the scanner. It is also part of the FCC ID. The options the backend supports can either be selected through -command line options to programs like scanimage or through GUI -elements in xscanimage, xsane, quiteinsane or kooka. +command line options to programs like +.BR scanimage (1) +or through GUI +elements in +.BR xscanimage (1), +.BR xsane (1), +.BR quiteinsane (1) +or +.BR kooka (1). .br -If you have any success with a scanner not listed here, or if you have +If you have any success with a scanner not listed here, or if you notice any strange behavior, please report to the backend maintainer or to the SANE mailing list. -Valid command line options and their syntax can be listed by using +.SH OPTIONS +Valid command line options and their syntax can be listed by using: + .RS scanimage \-\-help \-d teco2 .RE @@ -65,43 +74,55 @@ scanimage \-\-help \-d teco2 .B Scan Mode .TP -.B \-\-mode -selects the basic mode of operation of the scanner valid choices are +.B \-\-mode Lineart|Gray|Color +selects the basic mode of operation of the scanner. +The .I Lineart -, +mode is black and white only (1 bit). .I Gray -and +mode will produce 256 levels of gray (8 bits). .I Color -The Lineart mode is black and white only (1 bit). Gray mode -will produce 256 levels of gray (8 bits). Color will produce a 24 bits -color image. +will produce a 24 bits color image. .TP -.B \-\-resolution -Lineart and Gray -selects the resolution for a scan. The scanner can do all resolutions -between 1 and 600, in increments of 1. - - -Color -selects the resolution for a scan. The scanner can do only the -resolutions listed. +.B \-\-resolution 1..600 +Selects the resolution for a scan. The scanner can do all resolutions +between 1 and 600, in increments of 1, for +.IR Lineart " and " Gray . +For +.IR Color , +a restricted set of resolutions are available. +.B Note: All values with ydpi > 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 imagemagick command: -convert \-geometry (dpi/max_xdpi * 100%)x100% +.br +.I convert \-geometry (dpi/max_xdpi * 100%)x100% +.br max_xdpi is for the vm3575 constant with 300 dpi e.g. 600dpi adjust with: convert \-geometry 200%x100% .TP +.B \-\-preview +requests a preview scan. The resolution used for that scan is 50 dpi +(for VM356A and VM6575 75 dpi) and the scan area is the maximum allowed. +The scan mode is user selected. The default is "no". + +.TP .B Geometry options .TP -.B \-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 by default. +.B \-l, \-t, \-x, " \-y +Control the scan area: +.B \-l +sets the top left x coordinate, +.B \-t +the top left y coordinate, +.B \-x +selects the width and +.B \-y +the height of the scan area. All parameters are specified in millimeters by default. .TP @@ -112,49 +133,52 @@ area. All parameters are specified in millimeters by default. (color mode only) allows the user to specify a gamma table (see the next 3 parameters). +.SH OPTIONS FOR COLOR MODE +These options are valid for scan mode +.I Color +only. + .TP .B \-\-red\-gamma\-table -(color mode only) can be used to download a user defined +Can be used to download a user defined gamma table for the red channel. The table must be 256 bytes long. .TP .B \-\-green\-gamma\-table -(color mode only) can be used to download a user defined +Can be used to download a user defined gamma table for the green channel. The table must be 256 bytes long. .TP .B \-\-blue\-gamma\-table -(color mode only) can be used to download a user defined gamma table +Can be used to download a user defined gamma table for the blue channel. The table must be 256 bytes long. +.SH OPTIONS ONLY FOR VM3564, VM356A, VM3575 and VM6575 +These options are only available for VM3564, VM356A, VM3575 and VM6575 models. .TP -.B \-\-white\-level\-r -(VM3564, VM356A, VM3575 and VM6575 only) Selects what red radiance level should be +.B \-\-white\-level\-r 0..64 +Selects what red radiance level should be considered "white", when scanning some sheets by changing the calibration value loaded into the scanner. Scale 0..64 in steps of 1. .TP -.B \-\-white\-level\-g -(VM3564, VM356A, VM3575 and VM6575 only) Selects what green radiance level should be +.B \-\-white\-level\-g 0..64 +Selects what green radiance level should be considered "white", when scanning some sheets by changing the calibration i value loaded into the scanner. Scale 0..64 in steps of 1. .TP -.B \-\-white\-level\-b -(VM3564, VM356A, VM3575 and VM6575 only) Selects what blue radiance level should be +.B \-\-white\-level\-b 0..64 +Selects what blue radiance level should be considered "white", when scanning some sheets by changing the calibration value loaded into the scanner. Scale 0..64 in steps of 1. -.TP -.B \-\-preview -requests a preview scan. The resolution used for that scan is 50 dpi -(for VM356A and VM6575 75 dpi) and the scan area is the maximum allowed. -The scan mode is user selected. The default is "no". - .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/teco2.conf supports only one -information: the device name to use (eg /dev/scanner). +The configuration file +.I @CONFIGDIR@/teco2.conf +supports only one item: the device name to use (eg +.IR /dev/scanner ). .SH FILES @@ -190,13 +214,15 @@ implements what the scanner can support. .SH BUGS - Plenty. Parts of this backend are still under development. .SH "SEE ALSO" - -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) +.BR sane (7), +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1) .SH AUTHORS diff --git a/doc/sane-teco3.man b/doc/sane-teco3.man index 8fc6c3c..30853c3 100644 --- a/doc/sane-teco3.man +++ b/doc/sane-teco3.man @@ -34,15 +34,22 @@ The TECO VM number can usually be found at the back of the scanner. It is also part of the FCC ID. The options the backend supports can either be selected through -command line options to programs like scanimage or through GUI -elements in xscanimage or xsane. +command line options to programs like +.BR scanimage (1) +or through GUI +elements in +.BR xscanimage (1) +or +.BR xsane (1). .br -If you have any success with a scanner not listed here, or if you have +If you have any success with a scanner not listed here, or if you notice any strange behavior, please report to the backend maintainer or to the SANE mailing list. -Valid command line options and their syntax can be listed by using +.SH OPTIONS +Valid command line options and their syntax can be listed by using: + .RS scanimage \-\-help \-d teco3 .RE @@ -51,66 +58,71 @@ scanimage \-\-help \-d teco3 .B Scan Mode .TP -.B \-\-mode -selects the basic mode of operation of the scanner valid choices are +.B \-\-mode Black & White|Grayscale|Color +Selects the basic mode of operation of the scanner. +The .I Black & White -, +mode is black and white only (1 bit). .I Grayscale -and +will produce 256 levels of gray (8 bits). .I Color -The Black & White mode is black and white only (1 bit). Grayscale -will produce 256 levels of gray (8 bits). Color will produce a 24 bits -color image. +will produce a 24-bit color image. .TP -.B \-\-resolution -selects the resolution for a scan. The scanner can do all resolutions +.B \-\-resolution 1..1200 +Selects the resolution for a scan. The scanner can do all resolutions between 1 and 1200, in increments of 1. +.TP +.B \-\-preview +Requests a preview scan. The resolution used for that scan is 22 dpi +and the scan area is the maximum allowed. The scan mode is user +selected. The default is "no". .TP .B Geometry options .TP .B \-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 by default. - - -.TP -.B Enhancement options +Control the scan area: +.B \-l +sets the top left x coordinate, +.B \-t +the top left y coordinate, +.B \-x +selects the width and +.B \-y +the height of the scan area. +All parameters are specified in millimeters by default. + +.SH OPTIONS FOR COLOR MODE ONLY .TP .B \-\-custom\-gamma -(color mode only) allows the user to specify a gamma table (see the +Allows the user to specify a gamma table (see the next 3 parameters). .TP .B \-\-red\-gamma\-table -(color mode only) can be used to download a user defined +Can be used to download a user defined gamma table for the red channel. The table must be 1024 bytes long. .TP .B \-\-green\-gamma\-table -(color mode only) can be used to download a user defined +Can be used to download a user defined gamma table for the green channel. The table must be 1024 bytes long. .TP .B \-\-blue\-gamma\-table -(color mode only) can be used to download a user defined gamma table +Can be used to download a user defined gamma table for the blue channel. The table must be 1024 bytes long. -.TP -.B \-\-preview -requests a preview scan. The resolution used for that scan is 22 dpi -and the scan area is the maximum allowed. The scan mode is user -selected. The default is "no". - - .SH CONFIGURATION FILE -The configuration file @CONFIGDIR@/teco3.conf supports only one information: the device name to use (eg /dev/scanner). +The configuration file +.I @CONFIGDIR@/teco3.conf +supports only one item: the device name to use (eg +.IR /dev/scanner ). .SH FILES @@ -139,13 +151,15 @@ implements what the scanner can support. .SH BUGS - Not much. .SH "SEE ALSO" - -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) +.BR sane\-scsi (5), +.BR scanimage (1), +.BR xscanimage (1), +.BR xsane (1), +.BR sane (7) .SH AUTHOR diff --git a/doc/sane-test.man b/doc/sane-test.man index 08c9f86..3368bdf 100644 --- a/doc/sane-test.man +++ b/doc/sane-test.man @@ -17,9 +17,14 @@ capabilities of SANE. Therefore implements functions and options that are not (or seldom) found in other backends. .PP -The backend is commented out in @CONFIGDIR@/dll.conf, so either the comment +The backend is commented out in +.IR @CONFIGDIR@/dll.conf , +so either the comment character must be removed or the backend must be called explicitly. E.g. -`scanimage \-d test' or `xscanimage test'. +.I scanimage \-d test +or +.IR "xscanimage test" . + .SH SCAN MODE OPTIONS Option @@ -73,7 +78,8 @@ and "Solid black" are quite obvious, the other options need some more explanation. Color patterns are used to determine if all modes and their colors are represented correctly by the frontend. The grid should look like the same in every mode and resolution. A table of all the test pictures can be -found at: http://www.meier\-geinitz.de/sane/test\-backend/test\-pictures.html. +found at: +.IR http://www.meier\-geinitz.de/sane/test\-backend/test\-pictures.html . .PP If option .B invert\-endianness @@ -83,8 +89,9 @@ frontend uses the correct endianness. .PP If option .B read\-limit -is set, the maximum amount of data transferred with each call to sane_read() is -limited. +is set, the maximum amount of data transferred with each call to +.BR sane_read () +is limited. .PP Option .B read\-limit\-size @@ -105,8 +112,9 @@ used over the network. If option .B read\-return\-value is different from "Default", the selected status will be returned by every -call to sane_read(). This is useful to test the frontend's handling of the -SANE statuses. +call to +.BR sane_read (). +This is useful to test the frontend's handling of the SANE statuses. .PP If option .B ppl\-loss @@ -121,13 +129,15 @@ parameters it got before the start of the scan (which it shouldn't). .PP Option .B non\-blocking -determines if non-blocking IO for sane_read() should be used if supported by -the frontend. +determines if non-blocking IO for +.BR sane_read () +should be used if supported by the frontend. .PP If option .B select\-fd is set, the backend offers a select filedescriptor for detecting if -sane_read() will return data. +.BR sane_read() +will return data. .PP If option .B enable\-test\-options @@ -288,6 +298,7 @@ The static library implementing this backend. .I @LIBDIR@/libsane\-test.so The shared library implementing this backend (present on systems that support dynamic loading). + .SH ENVIRONMENT .TP .B SANE_CONFIG_DIR @@ -296,13 +307,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .TP .B SANE_DEBUG_TEST If the library was compiled with debug support enabled, this @@ -313,12 +330,16 @@ Example: export SANE_DEBUG_TEST=4 .SH "SEE ALSO" -sane(7), +.BR sane (7), +.BR scanimage (1), +.BR xscanimage (1) +.br .IR http://www.meier\-geinitz.de/sane/test\-backend/ .SH AUTHOR -Henning Meier-Geinitz <henning@meier\-geinitz.de> +Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de > .SH BUGS \- config file values aren't tested for correctness diff --git a/doc/sane-u12.man b/doc/sane-u12.man index 680ce0c..a09ae91 100644 --- a/doc/sane-u12.man +++ b/doc/sane-u12.man @@ -12,7 +12,7 @@ provides access to USB flatbed scanners based on Plusteks' ASIC bridge chip. .SH "SUPPORTED DEVICES" -The backend is able to support some early Plustek USB scanner based +The backend is able to support some early Plustek USB scanners that based their old parport design around the ASIC 98003 and other rebadged Plustek devices. The following tables will give you a short overview. @@ -52,6 +52,7 @@ ColorPage HR6 V1 0x0458 0x2004 To use your scanner with this backend, you need at least two entries in the configuration file .I @CONFIGDIR@/u12.conf + .RS .I [usb] vendor-id product-id .br @@ -91,16 +92,17 @@ lamps off, 0 --> do not change lamp status .RE .PP -See the u12.conf file for examples. +See the +.I u12.conf +file for examples. .PP .B Note: -.br You have to make sure, that the USB subsystem is loaded correctly and you have access to the device-node. For more details see -.B sane\-usb (5) +.BR sane\-usb (5) manpage. You might use -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) to check that you have access to your device. .PP .B Note: @@ -128,13 +130,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_U12 If the library was compiled with debug support enabled, this @@ -148,6 +156,9 @@ export SANE_DEBUG_U12=10 .BR sane (7), .BR sane\-usb (5), .BR sane\-plustek (5), +.BR sane\-find\-scanner (1), +.BR xscanimage (1), +.BR scanimage (1) .br .I @DOCDIR@/u12/U12.changes @@ -160,14 +171,17 @@ Additional info and hints can be obtained from our .br Mailing-List archive at: .br -.B http://www.sane\-project.org/mailing\-lists.html +.I http://www.sane\-project.org/mailing\-lists.html .PP To obtain debug messages from the backend, please set the environment-variable -.I SANE_DEBUG_U12 -before calling your favorite scan-frontend (i.e. xscanimage). +.B SANE_DEBUG_U12 +before calling your favorite scan-frontend (i.e. +.BR xscanimage (1)), +i.e.: + .br -.B i.e.: export SANE_DEBUG_U12=20 ; xscanimage +.I export SANE_DEBUG_U12=20 ; xscanimage .PP The value controls the verbosity of the backend. diff --git a/doc/sane-umax.man b/doc/sane-umax.man index 41b4beb..21caa3c 100644 --- a/doc/sane-umax.man +++ b/doc/sane-umax.man @@ -6,8 +6,12 @@ sane\-umax \- SANE backend for UMAX scanners .SH ABOUT THIS FILE -This file only is a short description of the umax-backend for sane! For detailed information take a look at -sane\-umax\-doc.html (it is included in the sane source directory and in the xsane online help)! +This file only is a short description of the +.B sane\-umax +backend for sane! For detailed information take a look at +sane\-umax\-doc.html (it is included in the sane source directory and in the +.BR xsane (1) +online help)! .SH DESCRIPTION @@ -80,7 +84,7 @@ able to send gamma tables to the scanner or to do a correct color calibration. This may result in strange color effects. If the minimum value is set too large then the backend is not able to allocate -the requested scsi buffer size and aborts with +the requested SCSI buffer size and aborts with out of memory error. The default is 32KB, for some scanners it should be increased to 64KB. .TP @@ -186,15 +190,16 @@ values: .br default = 2 .br -most scsi drivers allow internal command queueing with a depth +most SCSI drivers allow internal command queueing with a depth of 2 commands. In most cases it does not mprove anything when you -increase this value. When your scsi driver does not support any +increase this value. When your SCSI driver does not support any command queueing you can try to set this value to 1. .PP The special device name must be a generic SCSI device or a symlink to such a device. To find out to which device your scanner is assigned and how you have to set the -permissions of that device, have a look at sane\-scsi. +permissions of that device, have a look at +.BR sane\-scsi (5). .SH SCSI ADAPTER TIPS @@ -205,15 +210,16 @@ SCSI-adapters are not supported. So you typically need to purchase another SCSI- that is supported by your platform. See the relevant hardware FAQs and HOWTOs for your platform for more information. -The UMAX-scanners do block the scsi-bus for a few seconds while scanning. It is not +The UMAX-scanners do block the SCSI-bus for a few seconds while scanning. It is not necessary to connect the scanner to its own SCSI-adapter. But if you need short response time for your SCSI-harddisk (e.g. if your computer is a file-server) or -other scsi devices, I suggest you use an own SCSI-adapter for your UMAX-scanner. +other SCSI devices, I suggest you use an own SCSI-adapter for your UMAX-scanner. -If you have any problems with your Umax scanner, check your scsi chain +If you have any problems with your Umax scanner, check your SCSI chain (cable length, termination, ...). -See also: sane\-scsi(5) +See also: +.BR sane\-scsi (5) .SH FILES @@ -235,7 +241,8 @@ The shared library implementing this backend: 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: -SANE_DEBUG_UMAX values +.B SANE_DEBUG_UMAX +values. .ft CR .nf @@ -262,15 +269,14 @@ Example: export SANE_DEBUG_UMAX=8 .SH BUGS - -X-resolutions greater than 600 dpi sometimes make problems +X-resolutions greater than 600 dpi sometimes cause problems. .SH SEE ALSO -sane(7) +.BR sane (7), +.BR sane\-scsi (5) .SH AUTHOR - Oliver Rauch .SH EMAIL-CONTACT -Oliver.Rauch@Rauch-Domain.DE +.I Oliver.Rauch@Rauch-Domain.DE diff --git a/doc/sane-umax1220u.man b/doc/sane-umax1220u.man index a83db59..eea0e54 100644 --- a/doc/sane-umax1220u.man +++ b/doc/sane-umax1220u.man @@ -18,14 +18,14 @@ For more information on this backend, please visit This backend is also able to drive the UMAX Astra 1600U/2000U/2100U. The 2100U is confirmed to work. For the other scanners no reports have been received yet. Please contact us and tell us if your scanner works -(sane\-devel@alioth-lists.debian.net). +.RI ( sane\-devel@alioth-lists.debian.net ). .SH CONFIGURATION Usually, no manual configuration is necessary. The configuration file for this backend resides in .IR @CONFIGDIR@/umax1220u.conf . -Its contents is a list of device names that correspond to UMAX Astra scanners. +Its content is a list of device names that correspond to UMAX Astra scanners. Empty lines and lines starting with a hash mark (#) are ignored. A sample configuration file is shown below: @@ -37,8 +37,9 @@ configuration file is shown below: /dev/usb/scanner0 .fi -See sane\-usb(5) for information on how to set the access permissions on the usb -device files. +See +.BR sane\-usb (5) +for information on how to set the access permissions on the usb device files. .SH FILES @@ -61,7 +62,8 @@ 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: -SANE_DEBUG_UMAX1220U values +.B SANE_DEBUG_UMAX1220U +values: .ft CR .nf @@ -88,29 +90,31 @@ export SANE_DEBUG_UMAX1220U=10 If you keep getting I/O errors, try cycling the power on your scanner to reset it. -There is no way to cancel a scan, since the driver ignores sane_cancel(). +There is no way to cancel a scan, since the driver ignores +.BR sane_cancel (). If you try scanning an image which is too small, you will get I/O errors. Be sure to adjust the scan area before doing a scan, since by default, the scan area is zero. .SH SEE ALSO -sane(7), sane\-usb(5) +.BR sane (7), +.BR sane\-usb (5) .TP (Old) homepage: .I http://umax1220u\-sane.sourceforge.net/ .SH AUTHOR - -Marcio Luis Teixeira <marciot@users.sourceforge.net> +Marcio Luis Teixeira +.RI < marciot@users.sourceforge.net > .SH EMAIL-CONTACT -sane\-devel@alioth-lists.debian.net +.I sane\-devel@alioth-lists.debian.net .SH REPORTING BUGS - This backend isn't actively maintained. Nevertheless, bug reports and comments should be sent to the sane\-devel mailing list. When reporting bugs, please run -the backend with SANE_DEBUG_UMAX1220U set to 10 and attach a copy of the log -messages. +the backend with +.B SANE_DEBUG_UMAX1220U +set to 10 and attach a copy of the log messages. diff --git a/doc/sane-umax_pp.man b/doc/sane-umax_pp.man index 40972ce..1d15061 100644 --- a/doc/sane-umax_pp.man +++ b/doc/sane-umax_pp.man @@ -35,7 +35,7 @@ levels, there is a software lineart mode. The new generation models share a newer version of the 610P ASIC embedded in an EPAT chip. Only parts such as CCD and ADC change from one to another. They even all reports being UMAX Astra 1220P via IEEE1284. -There isn't software way to recognize them properly. Under windows, model is +There isn't a software method to recognize them properly. Under windows, model is set by the driver installed, regardless of the hardware. .PP .TP @@ -55,9 +55,13 @@ 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 saned(8) and sane\-net(5)). +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 chmod(1)). +(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. @@ -82,28 +86,36 @@ autodetect all parallel ports and probe them for scanner, but does not try direct hardware access .TP -/dev/ppi0 +.I /dev/ppi0 uses *BSD ppi device, depending on the number of available parallel port, you -have to use /dev/ppi1, /dev/ppi2, ... +have to use +.IR /dev/ppi1 , +.IR /dev/ppi2 ", ..." .TP -/dev/parport0 -uses linux ppdev device, depending on the +.I /dev/parport0 +uses Linux ppdev device, depending on the number of available parallel port, you -have to use /dev/parport1, /dev/parport2, ... +have to use +.IR /dev/parport1 , +.IR /dev/parport2 ", ..." .TP 0x378 does direct hardware access on the given address. Usual values are 0x378, 0x278, 0x3BC In this case, you have to run the scanner as -root (*BSD and linux), or with 'IOPL=yes' on +root (*BSD and Linux), or with 'IOPL=yes' on OS/2 .PP .RE \fBNOTE:\fR in all cases, you must have sufficient privileges to get access to the chosen device or address. Depending on the security settings, devices may not be available for all users. -You have to change permissions on the dev/ppi* or /dev/parport* devices. +You have to change permissions on the +.I /dev/ppi* +or +.I /dev/parport* +devices. .PP .RE You can rename any device using the @@ -119,12 +131,13 @@ You can rename any device using the options. These options apply to the last port option. .SH "CONFIGURATION" -Please make sure to edit umax_pp.conf +Please make sure to edit +.I umax_pp.conf .B before you use the backend. .PP The contents of the -.B umax_pp.conf +.I umax_pp.conf file is a list of options and device names that correspond to Umax scanners. Empty lines and lines starting with a hash mark (#) are ignored. @@ -141,8 +154,7 @@ and .BR buffer . Options -.B red\-gain -, +.BR red\-gain , .B green\-gain and .B blue\-gain @@ -209,13 +221,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_UMAX_PP If the library was compiled with debug support enabled, this @@ -265,14 +283,17 @@ level debug output .PP .SH "SEE ALSO" -sane(7), sane\-net(5), saned(8) +.BR sane (7), +.BR sane\-net (5), +.BR saned (8) .TP For latest bug fixes and information see .I http://umax1220p.sourceforge.net/ .SH "AUTHOR" -St\['e]phane Voltz <stef.dev@free.fr> +St\['e]phane Voltz +.RI < stef.dev@free.fr > .SH "CREDITS" Support for the 610P has been made possible thank to an hardware donation @@ -284,15 +305,24 @@ your scanner to be able to help you... .TP .I SANE version -run "scanimage \-V" to determine this +Run +.I "scanimage \-V" +to determine this .TP .I the backend version and your scanner hardware -run "SANE_DEBUG_UMAX_PP=255 scanimage \-L 2>log" as root. If you don't get any output -from the umax_pp backend, make sure a line "umax_pp" is included into -your @CONFIGDIR@/dll.conf. +Run +.I "SANE_DEBUG_UMAX_PP=255 scanimage \-L 2>log" +as root. If you don't get any output +from the +.B sane\-umax_pp +backend, make sure a line "umax_pp" is included into your +.I @CONFIGDIR@/dll.conf +file. If your scanner isn't detected, make sure you've defined the right port address, or the correct device -in your umax_pp.conf. +in your +.I umax_pp.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 scanner, both can be found in the manual of your scanner. diff --git a/doc/sane-usb.man b/doc/sane-usb.man index cb65c7f..ea4ee01 100644 --- a/doc/sane-usb.man +++ b/doc/sane-usb.man @@ -4,28 +4,30 @@ sane\-usb \- USB configuration tips for SANE .SH DESCRIPTION This manual page contains information on how to access scanners with a USB -interface. It focusses on two main topics: getting the scanner detected by the +interface. It focuses on two main topics: getting the scanner detected by the operating system kernel and using it with SANE. .PP This page applies to USB most backends and scanners, as they use the generic -sanei_usb interface. However, there is one exceptions: USB Scanners -supported by the microtek2 backend need a special USB kernel -driver, see +sanei_usb interface. However, there is one exception: USB Scanners +supported by the .BR sane\-microtek2 (5) -for details. +backend need a special USB kernel driver. .SH "QUICK START" This is a short HOWTO-like section. For the full details, read the following sections. The goal of this section is to get the scanner detected by .BR sane\-find\-scanner (1). .PP -Run sane\-find\-scanner. If it lists your scanner with the correct vendor and +Run +.BR sane\-find\-scanner (1). +If it lists your scanner with the correct vendor and product ids, you are done. See section .B "SANE ISSUES" for details on how to go on. .PP -sane\-find\-scanner doesn't list your scanner? Does it work as root? If yes, -there is a permission issue. See the +.BR sane\-find\-scanner (1) +doesn't list your scanner? Does it work as root? If yes, there is a permission issue. +See the .B LIBUSB section for details. .PP @@ -61,17 +63,35 @@ none /proc/bus/usb usbfs defaults 0 0 The permissions for the device files used by libusb must be adjusted for user access. Otherwise only root can use SANE devices. For .IR Linux , -the devices are located in /proc/bus/usb/ or in /dev/bus/usb, if you use +the devices are located in +.I /proc/bus/usb/ +or in +.IR /dev/bus/usb , +if you use udev. There are directories named e.g. "001" (the bus name) containing files "001", "002" etc. (the device files). The right device files can be found out by -running scanimage \-L as root. Setting permissions with "chmod" is not permanent, -however. They will be reset after reboot or replugging the scanner. -.PP -Usually udev or for older distributions the hotplug utilities are used, which +running: +.I "scanimage \-L: +as root. Setting permissions with +.BR chmod (1) +is not permanent, however. They will be reset after reboot or replugging the scanner. +.PP +Usually +.BR udev (7) +or for older distributions the hotplug utilities are used, which support dynamic setting of access permissions. SANE comes with udev and hotplug -scripts in the directory tools/udev and tools/hotplug. They can be used for -setting permissions, see @DOCDIR@/README.linux, tools/README and the README in -the tools/hotplug directory for more details. +scripts in the directory +.I tools/udev +and +.IR tools/hotplug . +They can be used for setting permissions, see +.IR @DOCDIR@/README.linux , +.IR tools/README +and the +.I README +in the +.I tools/hotplug +directory for more details. .PP For the .BR BSDs , @@ -81,8 +101,10 @@ Use chmod to apply appropriate permissions. .SH "SANE ISSUES" .PP -This section assumes that your scanner is detected by sane\-find\-scanner. It -doesn't make sense to go on, if this is not the case. While sane\-find\-scanner +This section assumes that your scanner is detected by +.BR sane\-find\-scanner (1). +It doesn't make sense to go on, if this is not the case. While +.BR sane\-find\-scanner (1) is able to detect any USB scanner, actual scanning will only work if the scanner is supported by a SANE backend. Information on the level of support can be found on the SANE webpage @@ -104,9 +126,13 @@ is the USB vendor id, and .I PRODUCT is the USB product id of the scanner. Both ids are non-negative integer numbers in decimal or hexadecimal format. The correct values for these fields can be -found by running sane\-find\-scanner, looking into the syslog (e.g., -/var/log/messages) or under Linux by issuing the command "cat -/proc/bus/usb/devices". This is an example of a config file line: +found by running +.BR sane\-find\-scanner (1), +looking into the syslog (e.g., +.IR /var/log/messages ) +or under Linux by issuing the command +.IR "cat /proc/bus/usb/devices" . +This is an example of a config file line: .PP .RS usb 0x055f 0x0006 @@ -137,14 +163,17 @@ If the library was compiled with debug support enabled, this environment variable controls the debug level for the USB I/O subsystem. E.g., a value of 128 requests all debug output to be printed. Smaller levels reduce verbosity. Values greater than 4 enable -libusb debugging (if available). Example: export SANE_DEBUG_SANEI_USB=4. +libusb debugging (if available). Example: +.IR "export SANE_DEBUG_SANEI_USB=4" . .PP .TP .B SANE_USB_WORKAROUND If your scanner does not work when plugged into a USB3 port, try -setting the environment variable SANE_USB_WORKAROUND to 1. This -may work around issues which happen with particular kernel -versions. Example: export SANE_USB_WORKAROUND=1. +setting the environment variable +.B SANE_USB_WORKAROUND +to 1. This may work around issues which happen with particular kernel +versions. Example: +.I export SANE_USB_WORKAROUND=1. .SH "SEE ALSO" .BR sane (7), @@ -153,4 +182,5 @@ versions. Example: export SANE_USB_WORKAROUND=1. .BR sane\-scsi (5) .SH AUTHOR -Henning Meier-Geinitz <henning@meier\-geinitz.de> +Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de > diff --git a/doc/sane-v4l.man b/doc/sane-v4l.man index 5af92ce..41a600e 100644 --- a/doc/sane-v4l.man +++ b/doc/sane-v4l.man @@ -63,13 +63,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I @CONFIGDIR@ +being searched (in this order). .TP .B SANE_DEBUG_V4L If the library was compiled with debug support enabled, this @@ -83,9 +89,12 @@ Juergen G. Schimmer, Henning Meier-Geinitz If more than one video card is present, a crash may occur. Frequency and geometry selection is missing. .br -Send bug reports to the SANE mailing list: sane\-devel@alioth-lists.debian.net. You must -be subscribed to the list to send mail. See -http://www.sane\-project.org/mailing\-lists.html for details. +Send bug reports to the SANE mailing list: +.IR sane\-devel@alioth-lists.debian.net . +You must be subscribed to the list to send mail. See +.I http://www.sane\-project.org/mailing\-lists.html +for details. .SH SEE ALSO -sane(7), xcam(1). +.BR sane (7), +.BR xcam (1) diff --git a/doc/sane-xerox_mfp.man b/doc/sane-xerox_mfp.man index c03ddd4..c41a770 100644 --- a/doc/sane-xerox_mfp.man +++ b/doc/sane-xerox_mfp.man @@ -11,6 +11,7 @@ Please see full list of supported devices at http://www.sane\-project.org/sane\-supported\-devices.html .SH CONFIGURATION +.TP .I @CONFIGDIR@/xerox_mfp.conf USB scanners do not need any configuration. @@ -22,12 +23,14 @@ For SCX\-4500W in network mode you need to specify .PP The .B host_address -is passed through resolver, thus can be a dotted quad or a name from /etc/hosts or resolvable through DNS. +is passed through resolver, thus can be a dotted quad or a name from +.I /etc/hosts +or resolvable through DNS. .SH FILES .TP .I @CONFIGDIR@/xerox_mfp.conf The backend configuration file. By default all scanner types/models are enabled, you -may want to comment out unwanted. +may want to comment out unwanted entries. .TP .I @LIBDIR@/libsane\-xerox_mfp.a The static library implementing this backend. @@ -35,7 +38,9 @@ The static library implementing this backend. .I @LIBDIR@/libsane\-xerox_mfp.so The shared library implementing this backend (present on systems that support dynamic loading). + .SH ENVIRONMENT +.TP .B SANE_DEBUG_XEROX_MFP If the library was compiled with debug support enabled, this environment variable controls the debug level for this backend. Higher @@ -49,19 +54,23 @@ Multicast autoconfiguration for LAN scanners is not implemented yet. IPv6 addres .SH BUGS AND SUPPORT If you have found a bug or need support please follow open\-source way of acquiring support via -mail\-lists http://www.sane\-project.org/mailing\-lists.html or SANE bug tracker -http://www.sane\-project.org/bugs.html +mail\-lists +.I http://www.sane\-project.org/mailing\-lists.html +or SANE bug tracker +.IR http://www.sane\-project.org/bugs.html . .SH AUTHORS -Alex Belkin <abc@telekom.ru> +Alex Belkin +.RI < abc@telekom.ru >. .br Samsung SCX\-4500W scan over network support by -Alexander Kuznetsov <acca(at)cpan.org> +Alexander Kuznetsov +.RI < acca(at)cpan.org >. .br Color scanning on Samsung M2870 model and Xerox Cognac 3215 & 3225 models by -Laxmeesh Onkar Markod <m.laxmeesh@samsung.com> +Laxmeesh Onkar Markod +.RI < m.laxmeesh@samsung.com >. .SH "SEE ALSO" .BR sane (7), .BR sane\-usb (5) -.br diff --git a/doc/sane.man b/doc/sane.man index ed8116c..80f7c1a 100644 --- a/doc/sane.man +++ b/doc/sane.man @@ -39,14 +39,17 @@ provides some means to manage one or more other backends. .SH "SOFTWARE PACKAGES" The package -.RB ` sane\-backends ' -contains a lot of backends, documentation, networking support, and the +.B sane\-backends +contains backends, documentation, networking support, and the command line frontend -.RB ` scanimage '. +.BR scanimage (1). The frontends -.RB ` xscanimage "', `" xcam "', and `" scanadf ' +.BR xscanimage (1), +.BR xcam (1), +and +.BR scanadf (1) are included in the package -.RB ` sane\-frontends '. +.BR sane\-frontends. Both packages can be downloaded from the .B SANE homepage @@ -60,11 +63,11 @@ The following sections provide short descriptions and links to more information about several aspects of .B SANE. A name with a number in parenthesis (e.g. -.RB ` sane\-dll (5)') +.BR sane\-dll (5)) points to a manual page. In this case -.RB ` "man 5 sane\-dll" ' +.I man\ 5\ sane\-dll will display the page. Entries like -.RI ` @DOCDIR@/README ' +.I @DOCDIR@/README are references to text files that were copied to the .B SANE documentation directory @@ -87,13 +90,13 @@ supported or unsupported), please contact us. See section HOW CAN YOU HELP SANE for details. There are lists for specific releases of SANE, for the current development version and a search engine: .IR http://www.sane\-project.org/sane\-supported\-devices.html . -The lists are also installed on your system at @DOCDIR@/. +The lists are also installed on your system at \fI@DOCDIR@/\fR. .TP .B SANE mailing list There is a mailing list for the purpose of discussing the SANE standard and its implementations: sane\-devel. Despite its name, the list is not only intended for developers, but also for users. There are also some more lists for special -topics, however, for users, sane\-devel is the right list. How to subscribe and +topics. However, for users, sane\-devel is the right list. How to subscribe and unsubscribe: .IR http://www.sane\-project.org/mailing\-lists.html . .TP @@ -136,58 +139,60 @@ available on the local host. See .BR saned (8). .TP .B sane\-find\-scanner -Command-line tool to find SCSI and USB scanners and determine their Unix +Command-line tool to find SCSI and USB scanners and determine their UNIX device files. See .BR sane\-find\-scanner (1). .PP Also, have a look at the .B sane\-frontends -package (including -.BR xscanimage ", " xcam ", and " scanadf ) +package (which includes +.BR xscanimage (1), +.BR xcam (1), +and +.BR scanadf (1)) and the frontend information page at .IR http://www.sane\-project.org/sane\-frontends.html . .SH "BACKENDS FOR SCANNERS" .TP 2 .B abaton -The SANE backend for Abaton flatbed scanners supports the Scan 300/GS (8bit, +Supports Abaton flatbed scanners such as the Scan 300/GS (8bit, 256 levels of gray) and the Scan 300/S (black and white, untested). See .BR sane\-abaton (5) for details. .TP .B agfafocus -This backend supports AGFA Focus scanners and the Siemens S9036 (untested). +Supports AGFA Focus scanners and the Siemens S9036 (untested). See .BR sane\-agfafocus (5) for details. .TP .B apple -The SANE backend for Apple flatbed scanners supports the following scanners: +Supports Apple flatbed scanners including the following scanners: AppleScanner, OneScanner and ColorOneScanner. See .BR sane\-apple (5) for details. .TP .B artec -The SANE Artec backend supports several Artec/Ultima SCSI flatbed scanners as +Supports several Artec/Ultima SCSI flatbed scanners as well as the BlackWidow BW4800SP and the Plustek 19200S. See .BR sane\-artec (5) for details. .TP .B artec_eplus48u -The SANE artec_eplus48u backend supports the scanner Artec E+ 48U and re-badged +Supports the Artec E+ 48U scanner and re-badged models like Tevion MD 9693, Medion MD 9693, Medion MD 9705 and Trust Easy Webscan 19200. See .BR sane\-artec_eplus48u (5) for details. .TP .B as6e -This is a SANE backend for using the Artec AS6E parallel port interface -scanner. See +Supports the Artec AS6E parallel port interface scanner. See .BR sane\-as6e (5) for details. .TP .B avision -This backend supports several Avision based scanners. This includes the +Supports several Avision based scanners including the original Avision scanners (like AV 630, AV 620, ...) as well as the HP ScanJet 53xx and 74xx series, Fujitsu ScanPartner, some Mitsubishi and Minolta film-scanners. @@ -196,80 +201,79 @@ See for details. .TP .B bh -The bh backend provides access to Bell+Howell Copiscan II series document -scanners. See +Supports Bell+Howell Copiscan II series document scanners. See .BR sane\-bh (5) for details. .TP .B canon -The canon backend supports the CanoScan 300, CanoScan 600, and CanoScan +Supports the CanoScan 300, CanoScan 600, and CanoScan 2700F SCSI flatbed scanners. See .BR sane\-canon (5) for details. .TP .B canon630u -The canon630u backend supports the CanoScan 630u and 636u USB scanners. See +Supports the CanoScan 630u and 636u USB scanners. See .BR sane\-canon630u (5) for details. .TP .B canon_dr -The canon_dr backend supports the Canon DR-Series ADF SCSI and USB scanners. See +Supports the Canon DR-Series ADF SCSI and USB scanners. See .BR sane\-canon_dr (5) for details. .TP .B canon_lide70 -The canon_lide70 backend supports the CanoScan LiDE 70 USB scanner. See +Supports the CanoScan LiDE 70 USB scanner. See .BR sane\-canon_lide70 (5) for details. .TP .B canon_pp -The canon_pp backend supports the CanoScan FB330P, FB630P, N340P and N640P -parallel port scanners. See +Supports the CanoScan FB330P, FB630P, N340P and N640P parallel port +scanners. See .BR sane\-canon_pp (5) for details. .TP .B cardscan -This backend provides support for Corex Cardscan USB scanners. See +Support for Corex Cardscan USB scanners. See .BR sane\-cardscan (5) for details. .TP -.B coolscan -This is a SANE backend for Nikon Coolscan film-scanners. See -.BR sane\-coolscan (5) -for details. -.TP -.B coolscan2 -This is a SANE backend for Nikon Coolscan film-scanners. -See +.B coolscan coolscan2 coolscan3 +Supports Nikon Coolscan film-scanners. See +.BR sane\-coolscan (5), .BR sane\-coolscan2 (5) +and +.BR sane\-coolscan3 (5) for details. .TP .B epjitsu -The epjitsu backend provides support for Epson-based Fujitsu USB scanners. See +Supports Epson-based Fujitsu USB scanners. See .BR sane\-epjitsu (5) for details. .TP .B epson -The SANE epson backend provides support for Epson SCSI, parallel port and USB -flatbed scanners. See +Supports Epson SCSI, parallel port and USB flatbed scanners. See .BR sane\-epson (5) for details. .TP +.B escl +Supports scanners through the eSCL protocol. See +.BR sane\-escl (5) +for details. +.TP .B fujitsu -The fujitsu backend provides support for most Fujitsu SCSI and USB, flatbed -and adf scanners. See +Supports most Fujitsu SCSI and USB, flatbed and adf scanners. See .BR sane\-fujitsu (5) for details. .TP .B genesys -The genesys backend provides support for several scanners based on the Genesys Logic +Supports several scanners based on the Genesys Logic GL646, GL841, GL843, GL847 and GL124 chips like the Medion 6471 and Hewlett-Packard 2300c. See .BR sane\-genesys (5) for details. .TP .B gt68xx -The gt68xx backend provides support for scanners based on the Grandtech +Supports scanners based on the Grandtech GT-6801 and GT-6816 chips like the Artec Ultima 2000 and several Mustek BearPaw CU and TA models. Some Genius, Lexmark, Medion, Packard Bell, Plustek, and Trust scanners are also supported. See @@ -277,160 +281,156 @@ and Trust scanners are also supported. See for details. .TP .B hp -The SANE hp backend provides access to Hewlett-Packard ScanJet scanners which -support SCL (Scanner Control Language by HP). See +Supports Hewlett-Packard ScanJet scanners which +utilize SCL (Scanner Control Language by HP). See .BR sane\-hp (5) for details. .TP .B hpsj5s -The SANE backend for the Hewlett-Packard ScanJet 5S scanner. See +Supports the Hewlett-Packard ScanJet 5S scanner. See .BR sane\-hpsj5s (5) for details. .TP .B hp3500 -The SANE backend for the Hewlett-Packard ScanJet 3500 series. See +Supports the Hewlett-Packard ScanJet 3500 series. See .BR sane\-hp3500 (5) for details. .TP .B hp3900 -The SANE backend for the Hewlett-Packard ScanJet 3900 series. See +Supports the Hewlett-Packard ScanJet 3900 series. See .BR sane\-hp3900 (5) for details. .TP .B hp4200 -The SANE backend for the Hewlett-Packard ScanJet 4200 series. See +Supports the Hewlett-Packard ScanJet 4200 series. See .BR sane\-hp4200 (5) for details. .TP .B hp5400 -The SANE backend for the Hewlett-Packard ScanJet 54XXC series. See +Supports the Hewlett-Packard ScanJet 54XXC series. See .BR sane\-hp5400 (5) for details. .TP .B hpljm1005 -The SANE backend for the Hewlett-Packard LaserJet M1005 scanner. See +Supports the Hewlett-Packard LaserJet M1005 scanner. See .BR sane\-hpljm1005(5) for details. .TP .B hs2p -The SANE backend for the Ricoh IS450 family of SCSI scanners. See +Supports the Ricoh IS450 family of SCSI scanners. See .BR sane\-hs2p (5) for details. .TP .B ibm -The SANE backend for some IBM and Ricoh SCSI scanners. See +Supports some IBM and Ricoh SCSI scanners. See .BR sane\-ibm (5) for details. .TP .B kodak -The SANE backend for some large Kodak scanners. See +Supports some large Kodak scanners. See .BR sane\-kodak (5) for details. .TP .B kodakaio -The SANE backend for Kodak AiO printer/scanners. See +Supports Kodak AiO printer/scanners. See .BR sane\-kodakaio (5) for details. .TP .B kvs1025 -The SANE backend for Panasonic KV-S102xC scanners. See +Supports Panasonic KV-S102xC scanners. See .BR sane\-kvs1025 (5) for details. .TP .B leo -This backend supports the Leo S3 and the Across FS-1130, which is a re-badged +Supports the LEO S3 and the Across FS-1130, which is a re-badged LEO FS-1130 scanner. See .BR sane\-leo (5) for details. .TP .B lexmark -This backend supports the Lexmark X1100 series of USB scanners. See +Supports the Lexmark X1100 series of USB scanners. See .BR sane\-lexmark (5) for details. .TP .B ma1509 -The ma1509 backend supports the Mustek BearPaw 1200F USB flatbed scanner. See +Supports the Mustek BearPaw 1200F USB flatbed scanner. See .BR sane\-ma1509 (5) for details. .TP .B magicolor -The magicolor backend supports the KONICA MINOLTA magicolor 1690MF multi-function printer/scanner/fax. See +Supports the KONICA MINOLTA magicolor 1690MF multi-function printer/scanner/fax. See .BR sane\-magicolor (5) for details. .TP .B matsushita -This backend supports some Panasonic KVSS high speed scanners. See +Supports some Panasonic KVSS high speed scanners. See .BR sane\-matsushita (5) for details. .TP .B microtek -The microtek backend provides access to the "second generation" Microtek -scanners with SCSI-1 command set. See +Supports "second generation" Microtek scanners with SCSI-1 command set. See .BR sane\-microtek (5) for details. .TP .B microtek2 -The microtek2 backend provides access to some Microtek scanners with a -SCSI-2 command set. See +Supports some Microtek scanners with a SCSI-2 command set. See .BR sane\-microtek2 (5) for details. .TP .B mustek -The SANE mustek backend supports most Mustek SCSI flatbed scanners including the +Supports most Mustek SCSI flatbed scanners including the Paragon and ScanExpress series and the 600 II N and 600 II EP (non-SCSI). Some Trust scanners are also supported. See .BR sane\-mustek (5) for details. .TP .B mustek_pp -The mustek_pp backend provides access to Mustek parallel port flatbed -scanners. See +Supports Mustek parallel port flatbed scanners. See .BR sane\-mustek_pp (5) for details. .TP .B mustek_usb -The mustek_usb backend provides access to some Mustek ScanExpress USB flatbed -scanners. See +Supports some Mustek ScanExpress USB flatbed scanners. See .BR sane\-mustek_usb (5) for details. .TP .B mustek_usb2 -The mustek_usb2 backend provides access to scanners using the SQ113 -chipset like the Mustek BearPaw 2448 TA Pro USB flatbed scanner. See +Supports scanners using the SQ113 chipset like the Mustek BearPaw 2448 TA Pro +USB flatbed scanner. See .BR sane\-mustek_usb2 (5) for details. .TP .B nec -The SANE nec backend supports the NEC PC-IN500/4C SCSI scanner. See +Supports the NEC PC-IN500/4C SCSI scanner. See .BR sane\-nec (5) for details. .TP .B niash -The niash backend supports the Agfa Snapscan Touch and the HP ScanJet 3300c, +Supports the Agfa Snapscan Touch and the HP ScanJet 3300c, 3400c, and 4300c USB flatbed scanners. See .BR sane\-niash (5) for details. .TP .B p5 -The SANE backend for Primax PagePartner. See +Supports the Primax PagePartner. See .BR sane\-p5 (5) for details. .TP .B pie -The pie backend provides access to Pacific Image Electronics (PIE) and Devcom +Supports Pacific Image Electronics (PIE) and Devcom SCSI flatbed scanners. See .BR sane\-pie (5) for details. .TP .B pixma -The pixma backend supports Canon PIXMA MP series (multi-function devices), +Supports Canon PIXMA MP series (multi-function devices), Canon imageCLASS series (laser devices), Canon MAXIFY series and some Canon CanoScan series. See .BR sane\-pixma (5) for details. .TP .B plustek -The SANE plustek backend supports USB flatbed scanners that use the National +Supports USB flatbed scanners that use the National Semiconductor LM983[1/2/3] chipset aka Merlin. Scanners using this LM983x chips include some models from Plustek, KYE/Genius, Hewlett-Packard, Mustek, Umax, Epson, and Canon. See @@ -438,103 +438,102 @@ Epson, and Canon. See for details. .TP .B plustek_pp -The SANE plustek_pp backend supports Plustek parallel port flatbed scanners. -Scanners using the Plustek ASIC P96001, P96003, P98001 and P98003 include some +Supports Plustek parallel port flatbed scanners using the Plustek ASIC P96001, +P96003, P98001 and P98003, which includes some models from Plustek, KYE/Genius, Primax. See .BR sane\-plustek_pp (5) for details. .TP .B ricoh -The ricoh backend provides access to the following Ricoh flatbed -scanners: IS50 and IS60. See +Supports the Ricoh flatbed scanners IS50 and IS60. See .BR sane\-ricoh (5) for details. .TP .B ricoh2 -The ricoh2 backend provides access to the following Ricoh flatbed -scanners: SG-3100SNw, SP-100SU, and SP-111SU. See +Supports the Ricoh flatbed scanners: SG-3100SNw, SP-100SU, and SP-111SU. See .BR sane\-ricoh2 (5) for details. .TP .B s9036 -The s9036 backend provides access to Siemens 9036 flatbed scanners. See +Supports Siemens 9036 flatbed scanners. See .BR sane\-s9036 (5) for details. .TP .B sceptre -The sceptre backend provides access to the Sceptre S1200 flatbed scanner. See +Supports the Sceptre S1200 flatbed scanner. See .BR sane\-sceptre (5) for details. .TP .B sharp -The SANE sharp backend supports Sharp SCSI scanners. See +Supports Sharp SCSI scanners. See .BR sane\-sharp (5) for details. .TP .B sm3600 -The SANE sm3600 backend supports the Microtek ScanMaker 3600 USB scanner. See +Supports the Microtek ScanMaker 3600 USB scanner. See .BR sane\-sm3600 (5) for details. .TP .B sm3840 -The SANE sm3840 backend supports the Microtek ScanMaker 3840 USB scanner. See +Supports the Microtek ScanMaker 3840 USB scanner. See .BR sane\-sm3840 (5) for details. .TP .B snapscan -The snapscan backend supports AGFA SnapScan flatbed scanners. See +Supports AGFA SnapScan flatbed scanners including some which are +rebadged to other brands. See .BR sane\-snapscan (5) for details. .TP .B sp15c -This backend supports the Fujitsu FCPA ScanPartner 15C flatbed scanner. See +Supports the Fujitsu FCPA ScanPartner 15C flatbed scanner. See .BR sane\-sp15c (5) for details. .TP .B st400 -The sane\-st400 backend provides access to Siemens ST400 and ST800. See +Supports the Siemens ST400 and ST800. See .BR sane\-st400 (5) for details. .TP .B tamarack -The SANE tamarack backend supports Tamarack Artiscan flatbed scanners. See +Supports Tamarack Artiscan flatbed scanners. See .BR sane\-tamarack (5) for details. .TP .B teco1 teco2 teco3 -The SANE teco1, teco2 and teco3 backends support some TECO scanners, -usually sold under the Relisys, Trust, Primax, Piotech, Dextra -names. See -.BR sane\-teco1 "(5), " sane\-teco2 "(5) and " sane\-teco3 (5) +Supports some TECO scanners, usually sold under the Relisys, Trust, +Primax, Piotech, Dextra names. See +.BR sane\-teco1 (5), +.BR sane\-teco2 (5) +and +.BR sane\-teco3 (5) for details. .TP .B u12 -The sane\-u12 backend provides USB flatbed scanners based on Plustek's ASIC 98003 +Supports USB flatbed scanners based on Plustek's ASIC 98003 (parallel-port ASIC) and a GeneSys Logics' USB-parport bridge chip like the Plustek OpticPro U(T)12. See .BR sane\-u12 (5) for details. .TP .B umax -The sane\-umax backend provides access to several UMAX-SCSI-scanners and some -Linotype Hell SCSI-scanners. See +Supports UMAX-SCSI-scanners and some Linotype Hell SCSI-scanners. See .BR sane\-umax (5) for details. .TP .B umax_pp -The sane\-umax_pp backend provides access to Umax parallel port flatbed scanners -and the HP 3200C. See +Supports Umax parallel port flatbed scanners and the HP 3200C. See .BR sane\-umax_pp (5) for details. .TP .B umax1200u -The sane\-umax1220u backend supports the UMAX Astra 1220U (USB) flatbed scanner +Supports the UMAX Astra 1220U (USB) flatbed scanner (and also the UMAX Astra 2000U, sort of). See .BR sane\-umax1220u (5) for details. .TP .B xerox_mfp -The sane\-xerox_mfp backend supports multiple Samsung-based Samsung, Xerox, and Dell +Supports multiple Samsung-based Samsung, Xerox, and Dell scanners. See .BR sane\-xerox_mfp (5) for details. @@ -547,38 +546,38 @@ and the list of projects in .SH "BACKENDS FOR DIGITAL CAMERAS" .TP 2 .B dc210 -Backend for Kodak DC210 Digital Camera. See +Supports the Kodak DC210 Digital Camera. See .BR sane\-dc210 (5). .TP .B dc240 -Backend for Kodak DC240 Digital Camera. See -.BR sane\-dc240 (5). +Supports the Kodak DC240 Digital Camera. See +.BR dc240 (5). .TP .B dc25 -Backend for Kodak DC20/DC25 Digital Cameras. See -.BR sane\-dc25 (5). +Supports Kodak DC20/DC25 Digital Cameras. See +.BR dc25 (5). .TP .B dmc -Backend for the Polaroid Digital Microscope Camera. See -.BR sane\-dmc (5). +Supports the Polaroid Digital Microscope Camera. See +.BR dmc (5). .TP .B gphoto2 -Backend for digital cameras supported by the gphoto2 library package. (See +Supports digital cameras supported by the gphoto2 library package. (See .I http://www.gphoto.org for more information and a list of supported cameras.) Gphoto2 supports over 140 different camera models. However, please note that more development and testing is needed before all of these cameras will be supported by .B SANE backend. See -.BR sane\-gphoto2 (5). +.BR gphoto2 (5). .TP .B qcam -Backend for Connectix QuickCam cameras. See -.BR sane\-qcam (5). +Supports Connectix QuickCam cameras. See +.BR qcam (5). .TP .B stv680 -The sane\-stv680 backend provides access to webcams with a stv680 chip. See -.BR sane\-stv680 (5) +Supports webcams with a stv680 chip. See +.BR stv680 (5) for details. .PP Also, have a look at the backend information page at @@ -589,7 +588,7 @@ and the list of projects in .SH "MISCELLANEOUS BACKENDS" .TP 2 .B dll -The sane\-dll library implements a +Implements a .B SANE backend that provides access to an arbitrary number of other .B SANE @@ -599,9 +598,13 @@ backends by dynamic loading. See .B net The .B SANE -network daemon saned provides access to scanners located on different +network daemon +.BR saned (8) +provides access to scanners located on different computers in connection with the net backend. See -.BR sane\-net "(5) and " saned (8). +.BR sane\-net (5) +and +.BR saned (8). .TP .B pnm PNM image reader pseudo-backend. The purpose of this backend is primarily to @@ -611,26 +614,22 @@ frontends. See .BR sane\-pnm (5). .TP .B pint -Backend for scanners that use the +Supports scanners that use the .B PINT (Pint Is Not Twain) device driver. The .B PINT driver is being actively developed on the OpenBSD platform, and has been -ported to a few other *nix-like operating systems. See +ported to a few other *NIX-like operating systems. See .BR sane\-pint (5). .TP .B test -The -.B SANE -test backend is for testing frontends and the +Tests frontends and the .B SANE installation. It provides test pictures and various test options. See .BR sane\-test (5). .TP .B v4l -The sane\-v4l library implements a -.B SANE -backend that provides generic access to video cameras and similar equipment +Provides generic access to video cameras and similar equipment using the .B V4L (Video for Linux) API. See @@ -646,11 +645,10 @@ By default, all .B SANE backends (drivers) are loaded dynamically by the .B sane\-dll -meta backend. If you have any questions about the dynamic loading, -read +meta backend. If you have any questions about the dynamic loading, read .BR sane\-dll (5). .B SANE -frontend can also be linked to other backends directly by copying or linking a +frontends can also be linked to other backends directly by copying or linking a backend to .B libsane.so in @@ -692,8 +690,8 @@ There are some links on how to find out about the protocol of a scanner: .PP If you start writing a backend or frontend or any other part of .BR SANE, -please contact the sane\-devel mailing list for coordination so the same work -isn't done twice. +please contact the sane\-devel mailing list for coordination so +that work is not duplicated. .SH "FILES" .TP @@ -715,12 +713,11 @@ documentation: The READMEs, text files for backends etc. If your device isn't found but you know that it is supported, make sure that it is detected by your operating system. For SCSI and USB scanners, use the -.B sane\-find\-scanner -tool (see .BR sane\-find\-scanner (1) -for details). It prints one line for each scanner it has detected and some -comments (#). If -.B sane\-find\-scanner +utility. +It prints one line for each scanner it has detected and some comments (#). +If +.BR sane\-find\-scanner (1) finds your scanner only as root but not as normal user, the permissions for the device files are not adjusted correctly. If the scanner isn't found at all, the operating system hasn't detected it and may need some help. Depending on @@ -732,24 +729,24 @@ If your scanner (or other device) is not connected over the SCSI bus or USB, read the backend's manual page for details on how to set it up. .PP -Now your scanner is detected by the operating system but not by +Is your scanner detected by the operating system but not by .BR SANE ? Try -.BR "scanimage \-L" . +.IR "scanimage\ \-L" . If the scanner is not found, check that the backend's name is mentioned in .IR @CONFIGDIR@/dll.conf . Some backends are commented out by default. Remove the comment sign for your backend in this case. Also some backends aren't compiled at all if one of their prerequisites are missing. Examples include dc210, dc240, canon_pp, hpsj5s, gphoto2, pint, qcam, v4l, net, sm3600, snapscan, pnm. If you need one of these -backends and they aren't available, read the build instructions in the +backends and it isn't available, read the build instructions in the .B README file and the individual manual pages of the backends. .PP Another reason for not being detected by -.B scanimage \-L -may be a missing or wrong configuration in the backend's configuration +.I scanimage\ \-L +may be a missing or incorrect configuration in the backend's configuration file. While .B SANE tries to automatically find most scanners, some can't be setup correctly @@ -763,8 +760,7 @@ relevant manual pages. For example, to get the maximum amount of debug information when testing a Mustek SCSI scanner, set environment variables .BR SANE_DEBUG_DLL ", " SANE_DEBUG_MUSTEK ", and " SANE_DEBUG_SANEI_SCSI to 128 and then invoke -.B scanimage -.B \-L . +.IR scanimage\ \-L . The debug messages for the dll backend tell if the mustek backend was found and loaded at all. The mustek messages explain what the mustek backend is doing while the SCSI debugging shows the low level handling. If you can't find @@ -772,12 +768,12 @@ out what's going on by checking the messages carefully, contact the sane\-devel mailing list for help (see REPORTING BUGS below). .PP Now that your scanner is found by -.BR "scanimage \-L" , +.IR "scanimage\ \-L" , try to do a scan: -.BR "scanimage >image.pnm" . +.IR "scanimage\ >image.pnm" . This command starts a scan for the default scanner with default settings. All the available options are listed by running -.BR "scanimage \-\-help" . +.IR "scanimage\ \-\-help" . If scanning aborts with an error message, turn on debugging as mentioned above. Maybe the configuration file needs some tuning, e.g. to setup the path to a firmware that is needed by some scanners. See the backend's manual page @@ -790,19 +786,17 @@ don't have a scanner or other .B SANE device: .IP -.B scanimage \-d -.I test -.B \-T +scanimage \-d test \-T .PP You should get a list of PASSed tests. You can do the same with your backend by changing "test" to your backend's name. .PP So now scanning with -.B scanimage +.B scanimage(1) works and you want to use one of the graphical frontends like -.BR xsane , -.BR xscanimage ", or" -.B quiteinsane +.BR xsane(1) , +.BR xscanimage(1) ", or" +.B quiteinsane(1) but those frontends don't detect your scanner? One reason may be that you installed two versions of .BR SANE . @@ -863,14 +857,16 @@ for details). .BR sane\-canon_dr (5), .BR sane\-canon_pp (5), .BR sane\-cardscan (5), -.BR sane\-coolscan2 (5), .BR sane\-coolscan (5), +.BR sane\-coolscan2 (5), +.BR sane\-coolscan3 (5), .BR sane\-dc210 (5), .BR sane\-dc240 (5), .BR sane\-dc25 (5), .BR sane\-dll (5), .BR sane\-dmc (5), .BR sane\-epson (5), +.BR sane\-escl (5), .BR sane\-fujitsu (5), .BR sane\-genesys (5), .BR sane\-gphoto2 (5), diff --git a/doc/saned.man b/doc/saned.man index d019901..89484d5 100644 --- a/doc/saned.man +++ b/doc/saned.man @@ -13,6 +13,9 @@ saned \- SANE network daemon .B [ \-b .I address .B ] +.B [ \-p +.I port +.B ] .B [ \-l ] .B [ \-D ] .B [ \-o ] @@ -34,7 +37,7 @@ flag requests that run in standalone daemon mode. In this mode, .B saned will listen for incoming client connections; -.B inetd +.BR inetd (8) is not required for .B saned operations in this mode. The @@ -44,6 +47,14 @@ flag tells to bind to the .I address given. The +.B \-p +flags tells +.B saned +to listen on the port given. A value of 0 tells +.B saned +to pick an unused port. The default is the +.B sane-port (6566). +The .B \-u flag requests that .B saned @@ -91,8 +102,12 @@ flag displays a short help message. .PP If .B saned -is run from other programs such as inetd, xinetd and systemd, check that -program's documentation on how to pass command-line options. +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 @@ -116,13 +131,16 @@ list. \fBdata_portrange\fP = \fImin_port\fP - \fImax_port\fP Specify the port range to use for the data connection. Pick a port range between 1024 and 65535; don't pick a too large port range, as it -may have performance issues. Use this option if your \fBsaned\fP +may have performance issues. Use this option if your +.B saned server is sitting behind a firewall. If that firewall is a Linux machine, we strongly recommend using the Netfilter \fInf_conntrack_sane\fP module instead. .TP \fBdata_connect_timeout\fP = \fItimeout\fP -Specify the time in milliseconds that saned will wait for a data +Specify the time in milliseconds that +.B saned +will wait for a data connection. Without this option, if the data connection is not done before the scanner reaches the end of scan, the scanner will continue to scan past the end and may damage it depending on the @@ -167,16 +185,29 @@ For .B saned to work properly in its default mode of operation, it is also necessary to add the appropriate configuration for -.I (x)inetd or systemd. +.BR xinetd (8), +.BR inetd (8) +or +.BR systemd (1) (see below). -Note that your inetd must support IPv6 if you -want to connect to saned over IPv6 ; xinetd, openbsd-inetd and systemd -are known to support IPv6, check the documentation for your inetd daemon. +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 -.I inetd, xinetd +.BR inetd (8), +.BR xinetd (8) and -.I systemd +.BR systemd (1) are described in more detail. .PP For the configurations below it is necessary to add a line of the following @@ -189,8 +220,11 @@ sane\-port 6566/tcp # SANE network scanner daemon .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 inetd configuration file +It is required to add a single line to the +.BR inetd (8) +configuration file .IR (/etc/inetd.conf) . .PP @@ -202,7 +236,8 @@ sane\-port stream tcp nowait saned.saned @SBINDIR@/saned saned .PP However, if your system uses .BR tcpd (8) -for additional security screening, you may want to disable saned +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 @@ -222,9 +257,13 @@ 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 xinetd is installed on your system instead of inetd the following example -for +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 @@ -247,20 +286,34 @@ service sane\-port .fi .ft R .RE + .SH SYSTEMD CONFIGURATION -Saned can be compiled with explicit systemd support. This +.B saned +can be compiled with explicit +.BR systemd (1) support. This will allow logging debugging information to be forwarded -to the systemd journal. The systemd support -requires compilation with the systemd-devel package +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. -Saned can be used wih systemd without the systemd integration -compiled in, but then logging of debug information is not supported. +.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. -The systemd configuration is different for the 2 options, so -both are described below. .SH Systemd configuration for saned with systemd support compiled in -for the systemd configuration we need to add 2 configuration files in +For +.BR systemd (1) +configuration we need to add 2 configuration files in .I /etc/systemd/system. .PP The first file we need to add here is called @@ -316,15 +369,20 @@ Also=saned.socket .PP You need to set an environment variable for .B SANE_CONFIG_DIR -pointing to the directory where saned can find its configuration files. +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 -.I (x)inetd -, systemd allows debugging output from backends set using +.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. @@ -332,15 +390,24 @@ 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 Saned is compiled WITH systemd integration -support, but it does not allow debugging information to be logged. +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 systemd configuration for saned, we need to add 2 configuration files in +For +.BR systemd (1) +configuration for +.BR saned , +we need to add 2 configuration files in .I /etc/systemd/system. .PP The first file we need to add here is called .I saned.socket. -It is identical to the version for systemd with the support compiled in. +It is identical to the version for +.BR systemd (1) +with the support compiled in. It shall have the following contents: .PP .RS @@ -362,7 +429,9 @@ WantedBy=sockets.target .PP The second file to be added is .I saned@.service -This one differes from the sersion with systemd integration compiled in: +This one differs from the version with +.BR systemd (1) +integration compiled in: .PP .RS .ft CR @@ -415,13 +484,19 @@ contain the configuration file. Under UNIX, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working -directory (".") and then in @CONFIGDIR@. If the value of the +directory (".") and then in +.IR @CONFIGDIR@ . +If the value of the environment variable ends with the directory separator character, then the default directories are searched after the explicitly specified directories. For example, setting .B SANE_CONFIG_DIR -to "/tmp/config:" would result in directories "tmp/config", ".", and -"@CONFIGDIR@" being searched (in this order). +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "@CONFIGDIR@" +being searched (in this order). .SH "SEE ALSO" .BR sane (7), @@ -430,7 +505,10 @@ to "/tmp/config:" would result in directories "tmp/config", ".", and .BR xcam (1), .BR sane\-dll (5), .BR sane\-net (5), -.BR sane\-"backendname" (5) +.BR sane\-"backendname" (5), +.BR inetd (8), +.BR xinetd (8), +.BR systemd (1), .br .I http://www.penguin-breeder.org/?page=sane\-net .SH AUTHOR diff --git a/doc/scanimage.man b/doc/scanimage.man index b439c45..7d48389 100644 --- a/doc/scanimage.man +++ b/doc/scanimage.man @@ -76,16 +76,16 @@ To print all available options: .SH OPTIONS Parameters are separated by a blank from single-character options (e.g. -\-d epson) and by a "=" from multi-character options (e.g. \-\-device\-name=epson). +.BR "\-d epson" ) +and by a "=" from multi-character options (e.g. +.BR \-\-device\-name=epson ). .PP The .B \-d or .B \-\-device\-name -options must be followed by a -.B SANE -device-name like +options must be followed by a SANE device-name like .RI ` epson:/dev/sg0 ' or .RI ` hp:/dev/usbscanner0 '. @@ -103,7 +103,9 @@ The .B \-\-format .I format option selects how image data is written to standard output or the file specified by -the \-\-output\-file option. +the +.B \-\-output\-file +option. .I format can be .BR pnm , @@ -169,9 +171,23 @@ feeders. is used to specify the format of the filename that each page will be written to. Each page is written out to a single file. If .I format -is not specified, the default of out%d.pnm (or out%d.tif for \-\-format tiff, -out%d.png for \-\-format png or out%d.jpg for \-\- format jpeg) will be used. -This option is incompatible with the \-\-output\-path option. +is not specified, the default of +.I out%d.pnm +(or +.I out%d.tif +for +.BR "\-\-format tiff" , +.I out%d.png +for +.B "\-\-format png" +or +.I out%d.jpg +for +.BR "\-\-format jpeg" ) +will be used. +This option is incompatible with the +.B \-\-output\-path +option. .I format is given as a printf style string with one integer parameter. .B \-\-batch\-start @@ -224,8 +240,9 @@ or option requests that .B scanimage saves the scanning output to the given path. This option is incompatible with the -\-\-batch option. The program will try to guess \-\-format from the file name. -If that is not possible, it will print an error message and exit. +\-\-batch option. The program will try to guess +.B \-\-format +from the file name. If that is not possible, it will print an error message and exit. .PP The .B \-n @@ -247,7 +264,7 @@ performs a few simple sanity tests to make sure the backend works as defined by the .B SANE API (in particular the -.B sane_read +.BR sane_read () function is exercised by this test). .PP The @@ -295,8 +312,8 @@ distribution that it came with and the version of the backend that it loads. Usually that's the dll backend. If more information about the version numbers of the backends are necessary, the .B DEBUG -variable for the dll backend can be used. Example: SANE_DEBUG_DLL=3 scanimage -\-L. +variable for the dll backend can be used. Example: +.I "SANE_DEBUG_DLL=3 scanimage \-L" . .PP As you might imagine, much of the power of .B scanimage @@ -310,7 +327,7 @@ invoke via a command-line of the form: .PP .RS -.B scanimage \-\-help \-\-device\-name +scanimage \-\-help \-\-device\-name .I dev .RE .PP @@ -318,7 +335,7 @@ The documentation for the device-specific options printed by .B \-\-help is best explained with a few examples: - \-l 0..218mm [0] +.B \-l 0..218mm [0] .br Top-left x position of scan area. .PP @@ -332,7 +349,7 @@ width (\-x) and height of scan-area (\-y). .RE - \-\-brightness \-100..100% [0] +.B \-\-brightness \-100..100% [0] .br Controls the brightness of the acquired image. .PP @@ -344,7 +361,7 @@ value in square brackets indicates that the current option value is 0 percent. .RE - \-\-default\-enhancements +.B \-\-default\-enhancements .br Set default values for enhancement controls. .PP @@ -360,7 +377,7 @@ option, the option-pair would effectively be a no-op. .RE - \-\-mode Lineart|Gray|Color [Gray] +.B \-\-mode Lineart|Gray|Color [Gray] .br Selects the scan mode (e.g., lineart or color). .PP @@ -383,11 +400,9 @@ is identical to .BR "\-\-mode Color" . .RE - \-\-custom\-gamma[=(yes|no)] [inactive] +.B \-\-custom\-gamma[=(yes|no)] [inactive] .br - Determines whether a builtin or a custom gamma-table -.br - should be used. + Determines whether a builtin or a custom gamma-table should be used. .PP .RS The description above shows that option @@ -418,7 +433,7 @@ would print the option settings that are in effect when the color-mode is selected. .RE - \-\-gamma\-table 0..255,... +.B \-\-gamma\-table 0..255,... .br Gamma-correction table. In color mode this option .br @@ -445,7 +460,7 @@ for details). .RE .br - \-\-filename <string> [/tmp/input.ppm] +.B \-\-filename <string> [/tmp/input.ppm] .br The filename of the image to be loaded. .PP @@ -454,7 +469,7 @@ The description above is an example of an option that takes an arbitrary string value (which happens to be a filename). Again, the value in brackets show that the option is current set to the filename -.BR /tmp/input.ppm . +.IR /tmp/input.ppm . .RE .SH ENVIRONMENT @@ -473,11 +488,15 @@ This file contains lines of the form .RS user:password:resource .PP -scanimage uses this information to answer user authorization requests +.B scanimage +uses this information to answer user authorization requests automatically. The file must have 0600 permissions or stricter. You should -use this file in conjunction with the \-\-accept\-md5\-only option to avoid +use this file in conjunction with the +.B \-\-accept\-md5\-only +option to avoid server-side attacks. The resource may contain any character but is limited to 127 characters. + .SH "SEE ALSO" .BR sane (7), .BR gamma4scanimage (1), @@ -488,10 +507,11 @@ to 127 characters. .BR sane\-dll (5), .BR sane\-net (5), .BR sane\-"backendname" (5) + .SH AUTHOR David Mosberger, Andreas Beck, Gordon Matzigkeit, Caskey Dickson, and many others. For questions and comments contact the sane\-devel mailinglist (see -http://www.sane\-project.org/mailing\-lists.html). +.IR http://www.sane\-project.org/mailing\-lists.html ). .SH BUGS For vector options, the help output currently has no indication as to diff --git a/doc/teco/teco2.txt b/doc/teco/teco2.txt index b45b795..83ea545 100644 --- a/doc/teco/teco2.txt +++ b/doc/teco/teco2.txt @@ -258,7 +258,7 @@ Likewise, if the input value is 0x700, the calibration value must be 0x924 And if the input value is 0x600, the calibration value must 0xAAA (0x800*0x800 / 0x600) -Though, carefull comparison with scans done under windows has shown that the +Though, careful comparison with scans done under windows has shown that the factor is slightly different from 0x800*0x800(=0x400000) but in stead it seems to be approximately 0x40302f (which would mean that the average value is approximately 0x803 in stead of 0x800). diff --git a/doc/umax/sane-umax-astra-doc.html b/doc/umax/sane-umax-astra-doc.html index 0b94019..d59fe3d 100644 --- a/doc/umax/sane-umax-astra-doc.html +++ b/doc/umax/sane-umax-astra-doc.html @@ -557,7 +557,7 @@ Supported scanners: <br> <font color="#990000">*** Astra 6400 and 6450 are firewire scanners: not tested.</font> <p> -<font color="#990000">UTA = Umax Transparancy Adapter, ADF = Automatic Document Feeder</font> +<font color="#990000">UTA = Umax Transparency Adapter, ADF = Automatic Document Feeder</font> <br> <font color="#990000">(X = supported by scanner, incl = is included)</font> <br> diff --git a/doc/umax/sane-umax-config-doc.html b/doc/umax/sane-umax-config-doc.html index a269079..57be082 100644 --- a/doc/umax/sane-umax-config-doc.html +++ b/doc/umax/sane-umax-config-doc.html @@ -121,7 +121,7 @@ and how you have to set the permissions of that device, have a look at <blockquote> When the generic scsi driver of the system supports selection of scsi buffer sizes the umax backend calculates the scsi buffer -sizes in dependance of the numbers of bytes per scanline. +sizes in dependence of the numbers of bytes per scanline. With <i>scsi-buffer-size-min</i> and <i>scsi-buffer-size-max</i> the scsi buffer size can be defined in a range between 4KB and 1MB. Especially the minimum value is very important. If this value is @@ -150,7 +150,7 @@ work you can set the option <i>force-preview-bit-rgb 1</i>. This always sets the preview bit when acquiring a color scan. The image quality may be reduced. <p> -Some scanners (especally very old scanners) may need the options +Some scanners (especially very old scanners) may need the options <i>slow-speed</i> and/or <i>care-about-smearing</i>. The value -1 uses the value defined by the driver, 0 disables the feature, 1 enables the feature. <b>Do not change these options unless @@ -411,7 +411,7 @@ export SANE_DEBUG_UMAX=8 <center> <hr WIDTH="100%"> <br> -<font color="#009900">This page has been changed on 27th. feburary 2001</font> +<font color="#009900">This page has been changed on 27th. february 2001</font> <br> <br> </center> diff --git a/doc/umax/sane-umax-mirage-doc.html b/doc/umax/sane-umax-mirage-doc.html index 5d15982..a98f288 100644 --- a/doc/umax/sane-umax-mirage-doc.html +++ b/doc/umax/sane-umax-mirage-doc.html @@ -258,7 +258,7 @@ series:</b></td> <br> <font color="#990000">* Mirage D-16L scanners allow scanning up to 800x800 / 1600x1600 dpi.</font> <p> -<font color="#990000">UTA = Umax Transparancy Adapter, ADF = Automatic Document Feeder</font> +<font color="#990000">UTA = Umax Transparency Adapter, ADF = Automatic Document Feeder</font> <br> <font color="#990000">(X = supported by scanner, incl = is included)</font> <br> diff --git a/doc/umax/sane-umax-others-doc.html b/doc/umax/sane-umax-others-doc.html index e1ed10d..9c0c072 100644 --- a/doc/umax/sane-umax-others-doc.html +++ b/doc/umax/sane-umax-others-doc.html @@ -217,7 +217,7 @@ and USB- scanners are not supported!</b> </table></center> <center> -<p><font color="#990000">UTA = Umax Transparancy Adapter, ADF = Automatic Document Feeder</font> +<p><font color="#990000">UTA = Umax Transparency Adapter, ADF = Automatic Document Feeder</font> <br><font color="#990000">(X = supported by scanner, incl = is included)</font> <br> <br> diff --git a/doc/umax/sane-umax-powerlook-doc.html b/doc/umax/sane-umax-powerlook-doc.html index 23eb3dc..47b4586 100644 --- a/doc/umax/sane-umax-powerlook-doc.html +++ b/doc/umax/sane-umax-powerlook-doc.html @@ -517,7 +517,7 @@ Supported scanners: <font color="#990000">* Powerlook 1100 is a firewire scanner: not tested</font> <br> <br> -<font color="#990000">UTA = Umax Transparancy Adapter, ADF = Automatic Document Feeder</font> +<font color="#990000">UTA = Umax Transparency Adapter, ADF = Automatic Document Feeder</font> <br> <font color="#990000">(X = supported by scanner, incl = is included)</font> <br> diff --git a/doc/umax/sane-umax-scanner-clones-doc.html b/doc/umax/sane-umax-scanner-clones-doc.html index f43d7eb..b6cc265 100644 --- a/doc/umax/sane-umax-scanner-clones-doc.html +++ b/doc/umax/sane-umax-scanner-clones-doc.html @@ -686,7 +686,7 @@ Here is a list of the UMAX-compatible scanners: <center> <p><font color="#990000">* Scanner is able to scan up to 1200 x 1200 dpi.</font> -<p><font color="#990000">UTA = Umax Transparancy Adapter, ADF = Automatic Document Feeder</font> +<p><font color="#990000">UTA = Umax Transparency Adapter, ADF = Automatic Document Feeder</font> <br><font color="#990000">(X = supported by scanner, incl = is included)</font> </center> @@ -1028,7 +1028,7 @@ Here is a list of the UMAX-compatible scanners: <center> <p><font color="#990000">* Scanner is able to scan up to 1200 x 1200 dpi.</font> -<p><font color="#990000">UTA = Umax Transparancy Adapter, ADF = Automatic Document Feeder</font> +<p><font color="#990000">UTA = Umax Transparency Adapter, ADF = Automatic Document Feeder</font> <br><font color="#990000">(X = supported by scanner, incl = is included)</font> </center> <br> diff --git a/doc/umax/sane-umax-standard-options-doc.html b/doc/umax/sane-umax-standard-options-doc.html index b80ca40..4cba2d2 100644 --- a/doc/umax/sane-umax-standard-options-doc.html +++ b/doc/umax/sane-umax-standard-options-doc.html @@ -82,7 +82,7 @@ is an example of the frontend <p><br> The options Gamma, brightness, contrast and negative in the main window come from xsane that calculates a gamma table using this values. -These values are corelated to highlight, midlight and shadow sliders in +These values are correlated to highlight, midlight and shadow sliders in the Histogram window. <br> diff --git a/doc/umax/sane-umax-uc-doc.html b/doc/umax/sane-umax-uc-doc.html index a894b47..9fd1e2e 100644 --- a/doc/umax/sane-umax-uc-doc.html +++ b/doc/umax/sane-umax-uc-doc.html @@ -595,7 +595,7 @@ Supported scanners: <p> -<p><font color="#990000">UTA = Umax Transparancy Adapter, ADF = Automatic Document Feeder</font> +<p><font color="#990000">UTA = Umax Transparency Adapter, ADF = Automatic Document Feeder</font> <br><font color="#990000">(X = supported by scanner, incl = is included)</font> diff --git a/doc/umax/sane-umax-vista-doc.html b/doc/umax/sane-umax-vista-doc.html index a4e68a4..67ff1a1 100644 --- a/doc/umax/sane-umax-vista-doc.html +++ b/doc/umax/sane-umax-vista-doc.html @@ -599,7 +599,7 @@ Supported scanners: <center> <p><font color="#990000">* Supervista S12 scanners allow scanning up to 1200x1200 dpi.</font> -<p><font color="#990000">UTA = Umax Transparancy Adapter, ADF = Automatic Document Feeder</font> +<p><font color="#990000">UTA = Umax Transparency Adapter, ADF = Automatic Document Feeder</font> <br><font color="#990000">(X = supported by scanner, incl = is included)</font> diff --git a/doc/umax/umax.CHANGES b/doc/umax/umax.CHANGES index 79cca89..fae53a4 100644 --- a/doc/umax/umax.CHANGES +++ b/doc/umax/umax.CHANGES @@ -5,9 +5,9 @@ umax -> sane-0.6: ----------------- * umax-sane-backend created: - - umax.c splitted in: + - umax.c split in: umax-cli.c, umax-scsi.c, umax-driver.c, umax-text.c - - umax.h splitted in: + - umax.h split in: umax-scanner.h, umax-scsi.h, umax-scsidef.h, umax-struct.h - outputs done by DBG(level,msg,args...) defined in debug.h - scsi-calls changed to sane-format (of sane-0.57) @@ -91,7 +91,7 @@ sane-0.6 / 0.61 / 0.62 -> 0.63 * reset adf and uta flag when not used (in sane_start) - * added possibilty to change calibration-mode if available + * added possibility to change calibration-mode if available * added send_halftone_pattern to umax-scsi.c @@ -119,7 +119,7 @@ sane-0.6 / 0.61 / 0.62 -> 0.63 and added missing 3 wid-bytes in scan.cmd * removed parameter color in three_pass_function_headers, - the color ist taken from us->three_pass_color now. + the color is taken from us->three_pass_color now. sane-0.63/0.64/0.65 -> 0.66 @@ -189,7 +189,7 @@ sane-0.66 -> 0.67 * removed bug (wrong length for 10 bit-gamma) in send_gamma_data - * changed all buffer-definitions to unsigned char and insterted + * changed all buffer-definitions to unsigned char and inserted type conversions, so there are no more warnings because of typemismatches. @@ -201,7 +201,7 @@ sane-0.67 -> 0.68 * changed open config to fp = sanei_config_open(UMAX_CONFIG_FILE) - * changed all set OPT...BIND commands, endless-loop happend in sane-0.67 + * changed all set OPT...BIND commands, endless-loop happened in sane-0.67 =>ane-0.67-umax-fix.diff.gz after that patch changed same for ten_bit_mode @@ -232,7 +232,7 @@ sane-0.68 -> 0.69 * changed name: umax_read_data_block -> umax_read_image_data - * changed length offest in do_inquiry from 5 to 4 + * changed length offset in do_inquiry from 5 to 4 and changed set_inquiry_length-offset from 5 to 4 * added calib_lines to structure US and added it to @@ -278,7 +278,7 @@ sane-0.69 -> 0.70 * moved reader_process from umax.c to umax-scsi.c and added routine for color ordering. - * reset length offest in do_inquiry from 4 to 5 + * reset length offset in do_inquiry from 4 to 5 and set_inquiry_length-offset from 4 to 5 because umax-S6E didn't work with it! @@ -395,7 +395,7 @@ sane-0.73 -> 0.74 There must'nt be a "wait_scanner" in calibration by driver routine!!! * added usage of driver internal values for calibration by driver if - the scanner does not give back the informations about the shading data: + the scanner does not give back the information about the shading data: width = dev->width * dev->inquiry_optical_res ( * 3 in RGB-mode ) * added 2 calibration-routines: @@ -497,7 +497,7 @@ build-2 -> build-3 (sane-1.0.1) * inversion of calibration is automatically set for Astra 6X0S and Vista S6E - * check for machine endianess is done only at backend start now! + * check for machine endianness is done only at backend start now! * made umax_do request_sense static @@ -566,7 +566,7 @@ build-7 -> build-8 * for Mirage D-16L the driver does not wait any more until scanner is repositioned this is experimental, it may work with other scanners too! - * Mirage D-16L does not give back informations for calibration by driver, + * Mirage D-16L does not give back information for calibration by driver, added new modus that "guesses" the values for Mirage D-16L. * Added read_shading_data to 16 bit calibration routine and made a routine for @@ -594,7 +594,7 @@ build-8 -> build-9 * gamma table is disabled in lineart and halftone modes - * if image is transmitted completly sane_read (close_pipe) + * if image is transmitted completely sane_read (close_pipe) returns with SANE_STATUS_GOOD in adf mode and in any other case with SANE_STATUS_EOF @@ -735,7 +735,7 @@ build-19 -> build-20 * added variable calibration_width_offset, Mirage D-16L offset of 308 is defined there and added offset of 28 for PowerLook III - * umax_do_calibration: guessed calibration data vaules use 2 bytes/color if scanner + * umax_do_calibration: guessed calibration data values use 2 bytes/color if scanner supports gamma input bit depth supports 2 bytes/color * calibration by driver now does work for PowerLook III @@ -780,7 +780,7 @@ build-21 -> build-22 higher scsi-ID (=priority) does scan without stops, the other scanner has to wait long time between the scsi-read commands, it also is possible to give - bothe scanners different scsi command queueing depth). + both scanners different scsi command queueing depth). * prepared replacement of pipe by sanei_ipc_* routines @@ -915,7 +915,7 @@ build-25 -> build-26 * added Mirage II as supported scanner * added routine umax_set_max_geometry that defines available surface - and resolution in dependance of scansource and double optical resolution + and resolution in dependence of scansource and double optical resolution (before this bugfix the change of dor mode overwrote the settings of scansource and vice versa) @@ -927,7 +927,7 @@ build-25 -> build-26 * sane_exit does free devlist - * added some options for Powerlook 3000 - still is not completly supported + * added some options for Powerlook 3000 - still is not completely supported build-26 -> build-27 @@ -1140,7 +1140,7 @@ build-41 -> build-42 * replaced fork() routines by sanei_thread routines - * added call sanei_scsi_req_flush_all(); to do_cancel - in threaded case this is not done when reader_process is cancled + * added call sanei_scsi_req_flush_all(); to do_cancel - in threaded case this is not done when reader_process is canceled * in reader_process: marked freed scsi buffers as freed(NULL). This is necessary when reader_process is run as thread! @@ -1156,7 +1156,7 @@ build-42 -> build-43 build-43 -> build-44 -------------------- - * the sense_hanlder stores the sense data in buffer[0] when valid sense data is avialable + * the sense_handler stores the sense data in buffer[0] when valid sense data is available * do_calibration: - corrected bug in reading calibration width from scanner (added /bytespp) @@ -1167,5 +1167,5 @@ build-43 -> build-44 build-44 -> build-45 -------------------- - * added defualt options for Linotype Opal2 + * added default options for Linotype Opal2 * changed bug in highlight-blue function (using green value) diff --git a/doc/umax/umax.FAQ b/doc/umax/umax.FAQ index 2ffbdfd..84d217c 100644 --- a/doc/umax/umax.FAQ +++ b/doc/umax/umax.FAQ @@ -64,7 +64,7 @@ A: There are at least two kind of scsi controller cards that Q: I use linux with a NCR/Symbios logic SCSI-Controller, sane does not work right. -A: There are two differen drivers in the linux Kernel/modules. +A: There are two different drivers in the linux Kernel/modules. Use the BSD-driver ncr53c8xx or sym53c8xx. ------------------------------------------------------------------------------- @@ -141,5 +141,5 @@ A: The optimization set by "-O2" makes problems, try which one of the following ------------------------------------------------------------------------------- -You find a lot of tips and informations in the internet. E.g. take a look +You find a lot of tips and information on the internet. E.g. take a look at http://www.scantips.com |