From d857bdc3f5ac51351786b163de46a3444069b113 Mon Sep 17 00:00:00 2001 From: Mattias Ellert Date: Thu, 15 May 2008 20:16:51 +0000 Subject: [PATCH] Man page and documentation fixes --- ChangeLog | 7 +- doc/descriptions-external/hp_rts88xx.desc | 27 ----- doc/sane-genesys.man | 4 +- doc/sane-lexmark.man | 28 ++--- doc/sane-mustek_pp.man | 128 ++++++++++------------ doc/sane-pixma.man | 1 - doc/sane-rts8891.man | 9 +- doc/sane-umax_pp.man | 2 +- 8 files changed, 84 insertions(+), 122 deletions(-) delete mode 100644 doc/descriptions-external/hp_rts88xx.desc diff --git a/ChangeLog b/ChangeLog index a3b8b093e..be96ddbb7 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,6 +1,9 @@ 2008-05-15 Mattias Ellert - * doc/sane-microtek2.man: Less fancy man page syntax that isn't - screwed up by the man2html converter for the website. + * doc/sane-genesys.man, doc/sane-lexmark.man, doc/sane-microtek2.man, + doc/sane-mustek_pp.man, doc/sane-pixma.man, doc/sane-rts8891.man, + doc/sane-umax_pp.man: Man page fixes + * doc/descriptions-external/hp_rts88xx.desc: removed since its + successor rts8891 is now included in the SANE distribution 2008-05-15 Mattias Ellert * backend/agfafocus.h, backend/artec_eplus48u.c, diff --git a/doc/descriptions-external/hp_rts88xx.desc b/doc/descriptions-external/hp_rts88xx.desc deleted file mode 100644 index b0d159330..000000000 --- a/doc/descriptions-external/hp_rts88xx.desc +++ /dev/null @@ -1,27 +0,0 @@ -; -; SANE Backend specification file -; -:backend "hp_rts88xx" ; name of backend -;:version "(0.17k)" ; version of backend -;:manpage "sane-hp_rts88xx" ; name of manpage (if it exists) -:url "http://hp44x0backend.sourceforge.net" ; backend's web page - -:comment "This backend is not included in the sane-backends distribution at the request of its author. There is a lot of different hardware worldwide on the market and the backend can't cover all this different versions." - -:devicetype :scanner ; start of a list of devices.... - -:mfg "Hewlett-Packard" ; name a manufacturer -:url "http://www.hp.com/" - -:model "HP4400C" ; name models for above-specified mfg. -:interface "USB" -:usbid "0x03f0" "0x0705" -:status :basic -:comment "grayscale 300DPI only" - -:model "HP4470C" -:interface "USB" -:usbid "0x03f0" "0x0805" -:status :basic -:comment "grayscale 300DPI only, XPA/bed mode" - diff --git a/doc/sane-genesys.man b/doc/sane-genesys.man index 35e3d408b..de09e6329 100644 --- a/doc/sane-genesys.man +++ b/doc/sane-genesys.man @@ -1,5 +1,5 @@ -.\" .IX sane-genesys .TH "sane-genesys" "5" "20 Nov 2005" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.IX sane-genesys .SH "NAME" sane-genesys \- SANE backend for GL646 and GL841 based USB flatbed scanners .SH "DESCRIPTION" @@ -27,7 +27,7 @@ the scan area. If you own a scanner other than the ones listed above that works with this backend, please let me know this by sending the scanner's exact model name and the USB vendor and device ids (e.g. from -.I /proc/bus/usb/devices , +.IR /proc/bus/usb/devices , .I sane-find-scanner or syslog) to the sane-devel mailing list. Even if the scanner's name is only slightly different from the models mentioned above, please let me know. diff --git a/doc/sane-lexmark.man b/doc/sane-lexmark.man index b383713dd..090648a33 100644 --- a/doc/sane-lexmark.man +++ b/doc/sane-lexmark.man @@ -1,14 +1,14 @@ -.\" .IX sane-lexmark .TH "sane-lexmark" "5" "16 April 2007" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.IX sane-lexmark .SH "NAME" -sane\-lexmark \- SANE backend for Lexmark X1100/X1200 Series scanners +sane-lexmark \- SANE backend for Lexmark X1100/X1200 Series scanners .SH "DESCRIPTION" The -.B sane\-lexmark +.B sane-lexmark library implements a SANE (Scanner Access Now Easy) backend that provides access to the scanner part of Lexmark X1100/X1200 AIOs. This backend should be considered -.B beta\-quality +.B beta-quality software! .PP The scanners that should work with this backend are: @@ -41,16 +41,16 @@ maintainer or to the SANE mailing list. Valid command line options and their syntax can be listed by using .RS -scanimage \-\-help \-d lexmark:usb: +scanimage --help -d lexmark:usb: .RE .TP .B Scan Mode Options .TP -.B \-\-mode +.B --mode selects the basic mode of operation of the scanner valid choices are -.I R Color , +.IR Color , .I Gray and .I Lineart @@ -59,7 +59,7 @@ Grayscale will produce 256 levels of gray (8 bits). Color mode allows for over 16 million different colors produced from 24 bits of color information. .TP -.B \-\-resolution +.B --resolution selects the resolution for a scan. The horizontal and vertical resolutions are set by the value of this option. The scanner is capable of the following resolutions for the specified option value: .PP @@ -78,14 +78,14 @@ by the value of this option. The scanner is capable of the following resolutions .RE .TP -.B \-\-preview +.B --preview requests a preview scan. The resolution used for that scan is 75 dpi and the scan area and the scan mode are as specified through their options, or the default if not specified. The default value for preview mode is "no". .TP -.B \-\-threshold -selects the minimum\-brightness to get a white point. The threshold is only used with Lineart mode scans. +.B --threshold +selects the minimum-brightness to get a white point. The threshold is only used with Lineart mode scans. It is specified as a percentage in the range 0..100% (in steps of 1). The default value of the threshold option is 50. @@ -96,10 +96,10 @@ The configuration file @CONFIGDIR@/lexmark.conf contains only the usb device id .SH "FILES" .TP -.I @LIBDIR@/libsane\-lexmark.a +.I @LIBDIR@/libsane-lexmark.a The static library implementing this backend. .TP -.I @LIBDIR@/libsane\-lexmark.so +.I @LIBDIR@/libsane-lexmark.so The shared library implementing this backend (present on systems that support dynamic loading). @@ -130,7 +130,7 @@ No bugs currently known. .SH "SEE ALSO" -sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) +sane-scsi(5), scanimage(1), xscanimage(1), xsane(1), sane(7) .SH "AUTHOR" diff --git a/doc/sane-mustek_pp.man b/doc/sane-mustek_pp.man index 4a1218899..572e1ff79 100644 --- a/doc/sane-mustek_pp.man +++ b/doc/sane-mustek_pp.man @@ -1,4 +1,3 @@ -.\" t .TH sane-mustek_pp 5 "November 17 2003" .de EX .sp @@ -32,52 +31,46 @@ The following scanners might work with this backend: .SS "CCD scanners" -.TS -lb lb lb lb -_ _ _ _ -l l l l. -Model: ASIC ID: CCD Type: works: -SE 6000 P 1013 00 yes -SM 4800 P 1013/1015 04/01 yes -SE 1200 ED Plus 1015 01 no -SM 1200 ED Plus 1015 01 no -SE 12000 P 1505 05 no -600 III EP Plus 1013/1015 00/01 yes -SE 600 SEP 1013 ?? yes -600 II EP ???? ?? no -MD9848 1015 00 yes -Gallery 4800 ???? ?? yes -Viviscan Compact II 1013 00 yes -.TE +.EX +Model: ASIC ID: CCD Type: works: +-------------------------------------------------------------- +SE 6000 P 1013 00 yes +SM 4800 P 1013/1015 04/01 yes +SE 1200 ED Plus 1015 01 no +SM 1200 ED Plus 1015 01 no +SE 12000 P 1505 05 no +600 III EP Plus 1013/1015 00/01 yes +SE 600 SEP 1013 ?? yes +600 II EP ???? ?? no +MD9848 1015 00 yes +Gallery 4800 ???? ?? yes +Viviscan Compact II 1013 00 yes +.EE .SS CIS scanners -.TS -lb lb lb -_ _ _ -l l l. -Model: ASIC ID: works: -Mustek 600 CP & 96 CP 1015 yes (*) -Mustek 1200 CP 1015 yes -Mustek 1200 CP+ 1015 yes -.TE +.EX +Model: ASIC ID: works: +----------------------------------------------- +Mustek 600 CP & 96 CP 1015 yes (*) +Mustek 1200 CP 1015 yes +Mustek 1200 CP+ 1015 yes +.EE -.TS -lb lb lb -_ _ _ -l l l. -OEM versions Original works +.EX +OEM versions Original works +-------------------------------------------------- Medion/LifeTec/Tevion - MD/LT 9350/9351 1200 CP yes - MD/LT 9850/9851 1200 CP maybe (**) - MD/LT 9858 1200 CP probably - MD/LT 9890/9891 1200 CP yes + MD/LT 9350/9351 1200 CP yes + MD/LT 9850/9851 1200 CP maybe (**) + MD/LT 9858 1200 CP probably + MD/LT 9890/9891 1200 CP yes Targa - Funline TS12EP 1200 CP yes - Funline TS6EP 600 CP yes + Funline TS12EP 1200 CP yes + Funline TS6EP 600 CP yes Trust - Easy Connect 9600+ 600 CP yes + Easy Connect 9600+ 600 CP yes Cybercom - 9352 1200 CP yes (***) -.TE + 9352 1200 CP yes (***) +.EE .HP (*) Calibration problems existed with earlier version of this driver. They seem to be solved now. @@ -299,7 +292,7 @@ Minimum: 0 Maximum: 100 .sp Example: option engine_delay 1 -.TP + .SS CCD driver options .TP .B top @@ -420,39 +413,34 @@ 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. -.sp -.TS -lb lb -l l. -level debug output -- - - 0 nothing - 1 errors - 2 warnings & minor errors - 3 additional information - 4 debug information - 5 code flow (not supported yet) - 6 special debug information -.TE +.EX +level debug output +-------------------------------------- + 0 nothing + 1 errors + 2 warnings & minor errors + 3 additional information + 4 debug information + 5 code flow (not supported yet) + 6 special debug information +.EE .TP .B SANE_DEBUG_SANEI_PA4S2 This variable sets the debug level for the SANE interface for the Mustek chipset A4S2. Note that enabling this will spam your terminal with some million lines of debug output. -.sp -.TS -lb lb -l l. -level debug output -- - - 0 nothing - 1 errors - 2 warnings - 3 things nice to know - 4 code flow - 5 detailed code flow - 6 everything -.TE +.EX +level debug output +---------------------------- + 0 nothing + 1 errors + 2 warnings + 3 things nice to know + 4 code flow + 5 detailed code flow + 6 everything +.EE + .SH "SEE ALSO" sane(7), sane-mustek(5), sane-net(5), saned(8), sane-find-scanner(1) diff --git a/doc/sane-pixma.man b/doc/sane-pixma.man index c9586de54..2f8ca0746 100644 --- a/doc/sane-pixma.man +++ b/doc/sane-pixma.man @@ -56,7 +56,6 @@ the Sane-dev mailing list. PIXMA MX850 .RE .PP -.\".PP The backend supports .br * resolutions at 75,150,300,600,1200,2400 and 4800 DPI (some maybe buggy), diff --git a/doc/sane-rts8891.man b/doc/sane-rts8891.man index a700b1987..afebfaca0 100644 --- a/doc/sane-rts8891.man +++ b/doc/sane-rts8891.man @@ -1,5 +1,5 @@ -.\" .IX sane-rts8891 .TH "sane-rts8891" "5" "16 March 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.IX sane-rts8891 .SH "NAME" sane-rts8891 \- SANE backend for Umax Astra 4400/4450 and Hewlett-Packard Scanjet 4470c scanners .SH "DESCRIPTION" @@ -18,6 +18,7 @@ The scanners that should work with this backend are: Umax 4400 good Umax 4450 untested HP 4470c good re-badged Astra 4400 + HP 4400c untested .fi .ft R .RE @@ -41,10 +42,8 @@ scanimage --help -d rts8891 .TP .B --mode selects the basic mode of operation of the scanner valid choices are -.I auto -.R , -.I Color -.R , +.IR auto , +.IR Color , .I Gray and .I Lineart diff --git a/doc/sane-umax_pp.man b/doc/sane-umax_pp.man index a1bbd9254..334570295 100644 --- a/doc/sane-umax_pp.man +++ b/doc/sane-umax_pp.man @@ -1,5 +1,5 @@ -.\" .IX sane-umax_pp .TH "sane-umax_pp" "5" "23 August 2004" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.IX sane-umax_pp .SH "NAME" sane-umax_pp \- SANE backend for Umax Astra parallel port flatbed scanners .SH "DESCRIPTION"