diff options
Diffstat (limited to 'doc/scanimage.man')
| -rw-r--r-- | doc/scanimage.man | 76 |
1 files changed, 48 insertions, 28 deletions
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 |