From 6a51099e9fe313a29a92cc60bd7189e7b67a59cf Mon Sep 17 00:00:00 2001 From: Ralph Little Date: Sun, 31 Jan 2021 22:06:39 -0800 Subject: [PATCH] doc: some more consistency changes to format. --- doc/sane-dc210.man | 43 ++++++++++---- doc/sane-dc240.man | 44 ++++++++++----- doc/sane-dmc.man | 24 ++++++-- doc/sane-epjitsu.man | 32 +++++++---- doc/sane-epson.man | 105 ++++++++++++++++++++-------------- doc/sane-epson2.man | 116 +++++++++++++++++++++++--------------- doc/sane-epsonds.man | 53 ++++++++++------- doc/sane-escl.man | 10 +++- doc/sane-find-scanner.man | 21 +++---- doc/sane-fujitsu.man | 40 +++++++------ doc/sane-genesys.man | 29 +++++++--- doc/sane-gphoto2.man | 55 +++++++++++++----- 12 files changed, 372 insertions(+), 200 deletions(-) diff --git a/doc/sane-dc210.man b/doc/sane-dc210.man index 7d3ad6502..849ecd428 100644 --- a/doc/sane-dc210.man +++ b/doc/sane-dc210.man @@ -5,7 +5,9 @@ sane\-dc210 \- SANE backend for Kodak DC210 Digital Camera .SH DESCRIPTION The .B sane\-dc210 -library implements a SANE (Scanner Access Now Easy) backend that +library implements a +.B SANE +(Scanner Access Now Easy) backend that provides access to the Kodak DC210 camera. THIS IS EXTREMELY ALPHA CODE! USE AT YOUR OWN RISK!! .SH "DEVICE NAMES" @@ -14,22 +16,27 @@ 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). 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 +78,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 +99,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 @@ -101,7 +114,13 @@ Henning Meier-Geinitz. 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). +or +.B SANE +should go to the +.B SANE +Developers mailing list +(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 70629ab93..7379dd693 100644 --- a/doc/sane-dc240.man +++ b/doc/sane-dc240.man @@ -5,7 +5,9 @@ sane\-dc240 \- SANE backend for Kodak DC240 Digital Camera .SH DESCRIPTION The .B sane\-dc240 -library implements a SANE (Scanner Access Now Easy) backend that +library implements a +.B SANE +(Scanner Access Now Easy) backend that provides access to the Kodak DC240 camera. THIS IS EXTREMELY ALPHA CODE! USE AT YOUR OWN RISK!! .SH "DEVICE NAMES" @@ -14,8 +16,9 @@ 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 @@ -23,14 +26,17 @@ to lost characters. Results are better when the "interrupt-unmask flag" is set in the IDE driver (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 +78,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 +99,7 @@ A value of 128 requests maximally copious debug output; smaller levels reduce verbosity. .SH "SEE ALSO" -sane(7) +.BT sane (7) .SH AUTHOR Peter S. Fales @@ -106,7 +118,13 @@ Not only should we check for the additional directory, but pictures may 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). +or +.B SANE +should go to the +.B SANE +Developers mailing list +(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-dmc.man b/doc/sane-dmc.man index 1aba8f8d6..7d1a62601 100644 --- a/doc/sane-dmc.man +++ b/doc/sane-dmc.man @@ -5,7 +5,9 @@ sane\-dmc \- SANE backend for the Polaroid Digital Microscope Camera .SH DESCRIPTION The .B sane\-dmc -library implements a SANE (Scanner Access Now Easy) backend that +library implements a +.B SANE +(Scanner Access Now Easy) backend that provides access to the Polaroid Digital Microscope Camera. .SH "DEVICE NAMES" This backend expects device names of the form: @@ -49,8 +51,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 @@ -106,8 +113,12 @@ 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 @@ -131,7 +142,8 @@ 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 diff --git a/doc/sane-epjitsu.man b/doc/sane-epjitsu.man index 14c7e5256..88714e7fd 100644 --- a/doc/sane-epjitsu.man +++ b/doc/sane-epjitsu.man @@ -7,7 +7,9 @@ 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 +.B 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 @@ -18,25 +20,32 @@ This backend may support other scanners. If physical inspection reveals an Epson .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: .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 @@ -63,7 +72,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 +109,9 @@ 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: diff --git a/doc/sane-epson.man b/doc/sane-epson.man index f09f07532..f7952e8e6 100644 --- a/doc/sane-epson.man +++ b/doc/sane-epson.man @@ -5,7 +5,9 @@ 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 +.B 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 +51,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. +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 +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 +83,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 +92,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 +100,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 +239,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 +298,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 +324,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 33acd782e..42a40fb23 100644 --- a/doc/sane-epson2.man +++ b/doc/sane-epson2.man @@ -5,7 +5,9 @@ sane\-epson2 \- SANE backend for EPSON scanners .SH DESCRIPTION The .B sane\-epson2 -library implements a SANE (Scanner Access Now Easy) backend that +library implements a +.B SANE +(Scanner Access Now Easy) backend that provides access to Epson flatbed scanners. This library supports a similar set of scanners as the sane\-epson driver but was developed to support a wider range of connections to the scanner; @@ -99,18 +101,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 +127,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 +136,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 +144,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 +267,51 @@ 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 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 @@ -349,10 +371,12 @@ If the scanner is not even recognized as an Epson scanner this is probably because the device name reported by the scanner is not in the correct format. Please send this information to the backend maintainer (email address is in the AUTHOR section of this man page or in the -AUTHORS file of the SANE distribution). +AUTHORS file of the +.B SANE +distribution). .SH AUTHOR 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 03bbbd238..db3bd2dbd 100644 --- a/doc/sane-epsonds.man +++ b/doc/sane-epsonds.man @@ -5,18 +5,21 @@ 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 +.B 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 +28,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 +37,53 @@ 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: .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 @@ -94,7 +104,10 @@ 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 2f9dbf5b9..30f366720 100644 --- a/doc/sane-escl.man +++ b/doc/sane-escl.man @@ -5,8 +5,9 @@ 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 +.B 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 @@ -63,6 +64,9 @@ 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 26c525874..5ad4734aa 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 @@ -28,7 +28,7 @@ and The test is done by sending a SCSI inquiry command and looking for a device type of "scanner" or "processor" (some old HP scanners seem to send "processor"). So -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) will find any SCSI scanner connected to those default device files even if it isn't supported by any SANE backend. .PP @@ -43,18 +43,18 @@ are tested. The files are opened and the vendor and device ids are determined, if the operating system supports this feature. Currently USB scanners are only found this way if they are supported by the Linux scanner module or the FreeBSD or OpenBSD uscanner driver. After that test, -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) tries to scan for USB devices found by the USB library libusb (if available). There is no special USB class for scanners, so the heuristics used to distinguish scanners from other USB devices is not perfect. -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) also tries to find out the type of USB chip used in the scanner. If detected, it will be printed after the vendor and product ids. -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) will even find USB scanners, that are not supported by any SANE backend. .PP -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) won't find most parallel port scanners, or scanners connected to proprietary ports. Some .B parallel port @@ -69,7 +69,7 @@ Prints a short usage message. .TP 8 .B \-v Verbose output. If used once, -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) shows every device name and the test result. If used twice, SCSI inquiry information and the USB device descriptors are also printed. .TP 8 @@ -82,15 +82,16 @@ Probe parallel port scanners. .B \-f Force opening all explicitly given devices as SCSI and USB devices. That's useful if -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) is wrong in determining the device type. .TP 8 .B \-F filename filename is a file that contains USB descriptors in the format of /proc/bus/usb/devices as used by Linux. -.B sane\-find\-scanner +.BR sane\-find\-scanner (1) 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 diff --git a/doc/sane-fujitsu.man b/doc/sane-fujitsu.man index ac86ff545..648420263 100644 --- a/doc/sane-fujitsu.man +++ b/doc/sane-fujitsu.man @@ -7,8 +7,10 @@ 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 +.B 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. @@ -51,31 +53,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,7 +100,9 @@ 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 @@ -225,12 +233,12 @@ iX500 support funded by: 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: diff --git a/doc/sane-genesys.man b/doc/sane-genesys.man index e4e30740c..cf4061b12 100644 --- a/doc/sane-genesys.man +++ b/doc/sane-genesys.man @@ -5,7 +5,9 @@ sane\-genesys \- SANE backend for GL646, GL841, GL843, GL847 and GL124 based USB .SH "DESCRIPTION" The .B sane\-genesys -library implements a SANE (Scanner Access Now Easy) backend that provides +library implements a +.B SANE +(Scanner Access Now Easy) backend that provides access to USB flatbed scanners based on the Genesys GL646, GL841, GL843, GL847 and GL124 chips. At present, the following scanners are known to work with this backend: .PP @@ -54,7 +56,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 @@ -275,17 +282,23 @@ Luc Verhaegen for donating a Canoscan LiDE 120. .SH "AUTHOR" Oliver Rauch .br -Henning Meier-Geinitz +Henning Meier-Geinitz +.I .br -Gerhard Jaeger +Gerhard Jaeger +.I .br -St\['e]phane Voltz +St\['e]phane Voltz +.I .br -Philipp Schmid +Philipp Schmid +.I .br -Pierre Willenbrock +Pierre Willenbrock +.I .br -Alexey Osipov for HP2400 final support +Alexey Osipov +.I for HP2400 final support .SH "LIMITATIONS" diff --git a/doc/sane-gphoto2.man b/doc/sane-gphoto2.man index 3e2a04602..7a2e8ac53 100644 --- a/doc/sane-gphoto2.man +++ b/doc/sane-gphoto2.man @@ -5,7 +5,9 @@ sane\-gphoto2 \- SANE backend for gphoto2 supported cameras .SH DESCRIPTION The .B sane\-gphoto2 -library implements a SANE (Scanner Access Now Easy) backend that +library implements a +.B SANE +(Scanner Access Now Easy) backend that provides access to the digital cameras supported by gphoto2. This backend has only been tested with a handful of cameras so far. Patches to support other models are welcome. @@ -24,22 +26,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 +92,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 +119,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 @@ -111,7 +133,10 @@ The manpage was largely copied from the dc210 manpage. 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). +or +.B SANE +should go to the SANE Developers mailing list +(see +.IR 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.