2007-02-11 Jochen Eisinger <jochen@penguin-breeder.org>

* doc/sane-mustek_pp.man: clean up markup, bug #304392
merge-requests/1/head
Jochen Eisinger 2007-02-11 17:36:31 +00:00
rodzic 218a1080d0
commit 78e9962f4b
2 zmienionych plików z 125 dodań i 179 usunięć

Wyświetl plik

@ -1,3 +1,7 @@
2007-02-11 Jochen Eisinger <jochen@penguin-breeder.org>
* doc/sane-mustek_pp.man: clean up markup, bug #304392
2007-02-11 Henning Meier-Geinitz <henning@meier-geinitz.de> 2007-02-11 Henning Meier-Geinitz <henning@meier-geinitz.de>
* po/sane-backends.pl.po: Polish translation fix (from Jakub * po/sane-backends.pl.po: Polish translation fix (from Jakub

Wyświetl plik

@ -1,4 +1,15 @@
.\" t
.TH sane-mustek_pp 5 "November 17 2003" .TH sane-mustek_pp 5 "November 17 2003"
.de EX
.sp
.nf
.ft CW
..
.de EE
.ft R
.fi
.sp
..
.IX sane-mustek_pp .IX sane-mustek_pp
.SH NAME .SH NAME
sane-mustek_pp \- SANE backend for Mustek parallel port flatbed scanners sane-mustek_pp \- SANE backend for Mustek parallel port flatbed scanners
@ -13,65 +24,60 @@ There are 2 classes of Mustek parallel port scanners: regular
(cold cathode device) scanners and (cold cathode device) scanners and
.B CIS .B CIS
(contact image sensor) scanners. (contact image sensor) scanners.
.P
The current version of this backend supports both CCD type scanners and The current version of this backend supports both CCD type scanners and
CIS type scanners. CIS type scanners.
.P
The following scanners might work with this backend: The following scanners might work with this backend:
.TP .SS "CCD scanners"
.BR "CCD scanners"
.PP
.RS
.ft CR
.nf
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
.fi
.ft R
.RE
.PP
.B CIS scanners
.PP
.RS
.ft CR
.nf
Model: ASIC ID: works:
--------------------- --------- -------
Mustek 600 CP & 96 CP 1015 yes (*)
Mustek 1200 CP 1015 yes
Mustek 1200 CP+ 1015 yes
OEM versions Original works .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
.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
.TS
lb lb lb
_ _ _
l l l.
OEM versions Original works
Medion/LifeTec/Tevion Medion/LifeTec/Tevion
MD/LT 9350/9351 1200 CP yes MD/LT 9350/9351 1200 CP yes
MD/LT 9850/9851 1200 CP maybe (**) MD/LT 9850/9851 1200 CP maybe (**)
MD/LT 9858 1200 CP probably MD/LT 9858 1200 CP probably
MD/LT 9890/9891 1200 CP yes MD/LT 9890/9891 1200 CP yes
Targa Targa
Funline TS12EP 1200 CP yes Funline TS12EP 1200 CP yes
Funline TS6EP 600 CP yes Funline TS6EP 600 CP yes
Trust Trust
Easy Connect 9600+ 600 CP yes Easy Connect 9600+ 600 CP yes
Cybercom Cybercom
9352 1200 CP yes (***) 9352 1200 CP yes (***)
.fi .TE
.ft R
.RE
.PP
.HP .HP
(*) Calibration problems existed with earlier version of (*) Calibration problems existed with earlier version of
this driver. They seem to be solved now. this driver. They seem to be solved now.
@ -80,15 +86,13 @@ this driver. They seem to be solved now.
MD/LT9850 type (striped scans, head moving in wrong MD/LT9850 type (striped scans, head moving in wrong
direction at some resolutions). It is not known whether direction at some resolutions). It is not known whether
the current version of the driver still has these problems. the current version of the driver still has these problems.
.br .PP
.B IF YOU HEAR LOUD CLICKING NOISES, IMMEDIATELY UNPLUG THE SCANNER ! .B IF YOU HEAR LOUD CLICKING NOISES, IMMEDIATELY UNPLUG THE SCANNER !
(This holds for any type of scanner). (This holds for any type of scanner).
.HP .HP
(***) Possibly, the engine_delay parameter has to be set to 1 ms (***) Possibly, the engine_delay parameter has to be set to 1 ms
for accurate engine movements. for accurate engine movements.
.PP .PP
Please note that this backend is still under construction. Certain models Please note that this backend is still under construction. Certain models
are currently not supported and some may never be because the communication are currently not supported and some may never be because the communication
protocol is still unknown (eg., SE 12000 P). protocol is still unknown (eg., SE 12000 P).
@ -116,13 +120,12 @@ in the line "mustek_pp".
.SH "DEVICE DEFINITION" .SH "DEVICE DEFINITION"
This backend allows multiple devices being defined and configured via the This backend allows multiple devices being defined and configured via the
.B .B mustek_pp.conf
mustek_pp.conf
file (even simultaneously, provided that they are connected to different file (even simultaneously, provided that they are connected to different
parallel ports). Please make sure to edit this file parallel ports). Please make sure to edit this file
.B before .B before
you use the backend. you use the backend.
.PP
A device can be defined as follows: A device can be defined as follows:
.PP .PP
.RS .RS
@ -134,7 +137,6 @@ where
.B <name> .B <name>
is an arbitrary name for the device, optionally enclosed by double quotes, is an arbitrary name for the device, optionally enclosed by double quotes,
for instance "LifeTec 9350". for instance "LifeTec 9350".
.PP
.HP .HP
.B <port name> .B <port name>
is the name of the parallel port to which the device is connected. In case is the name of the parallel port to which the device is connected. In case
@ -146,7 +148,7 @@ valid port names are
.BR parport1 , .BR parport1 ,
and and
.BR parport2 . .BR parport2 .
.PP
In case the backend is configured for raw IO In case the backend is configured for raw IO
.I (old .I (old
.IR setup) , .IR setup) ,
@ -162,7 +164,7 @@ 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 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, port your scanner is connected to, have a look at your /etc/conf.modules,
/etc/modules.conf and/or /proc/ioports. /etc/modules.conf and/or /proc/ioports.
.PP
If you are unsure which port to use, you can use the magic value If you are unsure which port to use, you can use the magic value
.BR * .BR *
to probe for your scanner. to probe for your scanner.
@ -182,19 +184,18 @@ is the driver to use for this device. Currently available drivers are:
.B Choosing the wrong driver can damage your scanner! .B Choosing the wrong driver can damage your scanner!
.br .br
Especially, using the 1200CP settings on a 600CP can be Especially, using the 1200CP settings on a 600CP can be
harmful. If the scanner starts making a loud noice, turn harmful. If the scanner starts making a loud noise, turn
it off immediately !!! it off immediately !!!
.br .PP
Using the cis600 driver on a 1200CP or a 1200CP+ is probably not Using the cis600 driver on a 1200CP or a 1200CP+ is probably not
dangerous. The cis1200+ driver also works for the 1200CP, and using dangerous. The cis1200+ driver also works for the 1200CP, and using
the cis1200 driver on a 1200CP+ will typically result in scans that the cis1200 driver on a 1200CP+ will typically result in scans that
cover only half of the width of the scan area (also not dangerous). cover only half of the width of the scan area (also not dangerous).
.br .PP
If unsure about the exact model of your OEM version, check the optical If unsure about the exact model of your OEM version, check the optical
resolution in the manual or on the box: the 600CP has a maximum optical resolution in the manual or on the box: the 600CP has a maximum optical
resolution of 300x600 DPI, whereas the 1200CP and 1200CP+ have a maximum resolution of 300x600 DPI, whereas the 1200CP and 1200CP+ have a maximum
optical resolution of 600x1200 DPI. optical resolution of 600x1200 DPI.
.PP .PP
Examples: Examples:
.PP .PP
@ -228,11 +229,8 @@ Options always apply to the scanner definition that precedes them. There
are no global options. Options are also driver-specific: not all drivers are no global options. Options are also driver-specific: not all drivers
support all possible options. support all possible options.
.SS Common options
.TP .TP
.B Common options
.RS 4
.PP
.HP
.B bw <value> .B bw <value>
Black/white discrimination value to be used during lineart scanning. Pixel Black/white discrimination value to be used during lineart scanning. Pixel
values below this value are assumed to be black, values above are values below this value are assumed to be black, values above are
@ -243,15 +241,11 @@ Default value: 127
Minimum: 0 Minimum: 0
.br .br
Maximum: 255 Maximum: 255
.PP .sp
Example: option bw 150 Example: option bw 150
.PP
.RE .SS CIS driver options
.TP .TP
.B CIS driver options
.RS 4
.PP
.HP
.B top_adjust <value> .B top_adjust <value>
Vertical adjustment of the origin, expressed in millimeter (floating point). Vertical adjustment of the origin, expressed in millimeter (floating point).
This option can be used to calibrate the position of the origin, within This option can be used to calibrate the position of the origin, within
@ -265,9 +259,9 @@ Minimum: -5.0
.br .br
Maximum: 5.0 Maximum: 5.0
.br .br
.PP .sp
Example: option top_adjust -2.5 Example: option top_adjust -2.5
.HP .TP
.B slow_skip .B slow_skip
Turns fast skipping to the start of the scan region off. When the region to Turns fast skipping to the start of the scan region off. When the region to
scan does not start at the origin, the driver will try to move the scanhead scan does not start at the origin, the driver will try to move the scanhead
@ -276,11 +270,11 @@ this may not work, resulting in large inaccuracies (up to centimeters).
By setting this option, the driver is forced to use normal speed during By setting this option, the driver is forced to use normal speed during
skipping, which can circumvent the accuracy problems. Currently, there are skipping, which can circumvent the accuracy problems. Currently, there are
no models for which these inaccuracy problems are known to occur. no models for which these inaccuracy problems are known to occur.
.br .sp
By default, fast skipping is used. By default, fast skipping is used.
.PP .sp
Example: option slow_skip Example: option slow_skip
.HP .TP
.B engine_delay <value> .B engine_delay <value>
Under normal circumstances, it is sufficient for the driver to wait for the Under normal circumstances, it is sufficient for the driver to wait for the
scanner signaling that the engine is stable, before a new engine command can scanner signaling that the engine is stable, before a new engine command can
@ -293,144 +287,103 @@ can be set. If it is set, the driver waits an additional amount of time after
every engine command, equal to the engine_delay parameter, expressed in every engine command, equal to the engine_delay parameter, expressed in
milliseconds. It practice an engine_delay of 1 ms is usually sufficient. The milliseconds. It practice an engine_delay of 1 ms is usually sufficient. The
maximum delay is 100 ms. maximum delay is 100 ms.
.br .sp
Note that every additional ms of delay can add up to 14 seconds to the total Note that every additional ms of delay can add up to 14 seconds to the total
scanning time (highest resolution), so an as small as possible value is scanning time (highest resolution), so an as small as possible value is
preferred. preferred.
.br .sp
Default value: 0 Default value: 0
.br .br
Minimum: 0 Minimum: 0
.br .br
Maximum: 100 Maximum: 100
.br .sp
.PP
Example: option engine_delay 1 Example: option engine_delay 1
.PP
.RE
.TP .TP
.B CCD driver options .SS CCD driver options
.RS 4 .TP
.HP
.B top <value> .B top <value>
Number of scanlines to skip to the start of the scan area. The number can Number of scanlines to skip to the start of the scan area. The number can
be any positive integer. Values known to me are 47 and 56. be any positive integer. Values known to me are 47 and 56.
.br .sp
Default value: 47 Default value: 47
.br .br
Minimum: 0 Minimum: 0
.br .br
Maximum: none Maximum: none
.br .br
.PP .sp
Example: option top 56 Example: option top 56
.HP .TP
.B waitbank <value> .B waitbank <value>
The number of usecs to wait for a bank change. You should not touch this The number of usecs to wait for a bank change. You should not touch this
value actually. May be any positive integer value actually. May be any positive integer
.br .sp
Default value: 700 Default value: 700
.br .br
Minimum: 0 Minimum: 0
.br .br
Maximum: none Maximum: none
.br .sp
.PP
Example: option waitbank 700 Example: option waitbank 700
.PP
.RE
.PP .PP
A sample configuration file is shown below: A sample configuration file is shown below:
.PP .PP
.RS .EX
# #
.br
# LifeTec/Medion 9350 on port 0x378 # LifeTec/Medion 9350 on port 0x378
.br
# #
.br
scanner "LifeTec 9350" 0x378 cis1200 scanner "LifeTec 9350" 0x378 cis1200
.RS 3
# Some calibration options (examples!). # Some calibration options (examples!).
.br
option bw 127 option bw 127
.br
option top_skip -0.8 option top_skip -0.8
.RE
# #
.br
# A Mustek 600CP on port 0x3BC # A Mustek 600CP on port 0x3BC
.br
# #
.br
scanner "Mustek 600CP" 0x3BC cis600 scanner "Mustek 600CP" 0x3BC cis600
.RS 3
# Some calibration options (examples!). # Some calibration options (examples!).
.br
option bw 120 option bw 120
.br
option top_skip 1.2 option top_skip 1.2
.RE
# #
.br
# A Mustek 1200CP+ on port 0x278 # A Mustek 1200CP+ on port 0x278
.br
# #
.br
scanner "Mustek 1200CP plus" 0x278 cis1200+ scanner "Mustek 1200CP plus" 0x278 cis1200+
.RS 3
# Some calibration options (examples!). # Some calibration options (examples!).
.br
option bw 130 option bw 130
.br
option top_skip 0.2 option top_skip 0.2
.RE
# #
.br
# A Mustek 600 III EPP on port parport0 # A Mustek 600 III EPP on port parport0
.br
# #
.br
scanner "Mustek 600 III EPP" parport0 ccd300 scanner "Mustek 600 III EPP" parport0 ccd300
.RS 3
# Some calibration options (examples!). # Some calibration options (examples!).
.br
option bw 130 option bw 130
.br
option top 56 option top 56
.RE .EE
.RE
.SH GLOBAL OPTIONS .SH GLOBAL OPTIONS
.PP .PP
You can control the overall behaviour of the mustek_pp backend by global 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. options which precede any scanner definition in the mustek_pp.conf file.
.br .sp
Currently, there is only one global option: Currently, there is only one global option:
.SS Global options
.TP .TP
.B Global options
.RS 4
.PP
.HP
.B no_epp .B no_epp
Disable parallel port mode EPP: works around a known bug in the Linux parport Disable parallel port mode EPP: works around a known bug in the Linux parport
code. Enable this option, if the backend hangs when trying to access the code. Enable this option, if the backend hangs when trying to access the
parallel port in EPP mode. parallel port in EPP mode.
.br .sp
Default value: use EPP Default value: use EPP
.PP .sp
Example: option no_epp Example: option no_epp
.PP
.RE
.SH FILES .SH FILES
.TP .TP
@ -467,49 +420,39 @@ If the library was compiled with debug support enabled, this
environment variable controls the debug level for this backend. E.g., environment variable controls the debug level for this backend. E.g.,
a value of 128 requests all debug output to be printed. Smaller a value of 128 requests all debug output to be printed. Smaller
levels reduce verbosity. levels reduce verbosity.
.sp
.PP .TS
.RS lb lb;
.ft CR l l.
.nf level debug output
level debug output - -
------- ------------------------------ 0 nothing
0 nothing 1 errors
1 errors 2 warnings & minor errors
2 warnings & minor errors 3 additional information
3 additional information 4 debug information
4 debug information 5 code flow (not supported yet)
5 code flow (not supported yet) 6 special debug information
6 special debug information .TE
.fi
.ft R
.RE
.PP
.TP .TP
.B SANE_DEBUG_SANEI_PA4S2 .B SANE_DEBUG_SANEI_PA4S2
This variable sets the debug level for the SANE interface for the Mustek 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 chipset A4S2. Note that enabling this will spam your terminal with some
million lines of debug output. million lines of debug output.
.sp
.PP .TS
.RS lb lb;
.ft CR l l.
.nf level debug output
level debug output - -
------- ------------------------------- 0 nothing
0 nothing 1 errors
1 errors 2 warnings
2 warnings 3 things nice to know
3 things nice to know 4 code flow
4 code flow 5 detailed code flow
5 detailed code flow 6 everything
6 everything .TE
.fi
.ft R
.RE
.PP
.PP
.SH "SEE ALSO" .SH "SEE ALSO"
sane(7), sane-mustek(5), sane-net(5), saned(8), sane-find-scanner(1) sane(7), sane-mustek(5), sane-net(5), saned(8), sane-find-scanner(1)
@ -522,16 +465,16 @@ For additional information on the CIS driver, see
.I http://home.scarlet.be/eddy_de_greef/ .I http://home.scarlet.be/eddy_de_greef/
.SH AUTHORS .SH AUTHORS
Jochen Eisinger <jochen.eisinger@gmx.net> .nf
.br Jochen Eisinger <jochen at penguin-breeder dot org>
Eddy De Greef <eddy_de_greef at scarlet dot be> Eddy De Greef <eddy_de_greef at scarlet dot be>
.fi
.SH BUGS .SH BUGS
Too many... please send bug reports to Too many... please send bug reports to
.I sane-devel@lists.alioth.debian.org .I sane-devel@lists.alioth.debian.org
(note that you have to subscribe first to the list before you can send (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 http://www.sane-project.org/mailing-lists.html)
.PP
.SH BUG REPORTS .SH BUG REPORTS
If something doesn't work, please contact us (Jochen for the CCD scanners, If something doesn't work, please contact us (Jochen for the CCD scanners,
@ -557,4 +500,3 @@ if you have comments about the documentation (what could be done better), or you
think I should know something, please include it. think I should know something, please include it.
.TP .TP
.I some nice greetings .I some nice greetings
.