summaryrefslogtreecommitdiff
path: root/doc/sane-genesys.man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sane-genesys.man')
-rw-r--r--doc/sane-genesys.man157
1 files changed, 81 insertions, 76 deletions
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