summaryrefslogtreecommitdiff
path: root/doc/scanimage.man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/scanimage.man')
-rw-r--r--doc/scanimage.man74
1 files changed, 34 insertions, 40 deletions
diff --git a/doc/scanimage.man b/doc/scanimage.man
index a86fe2a..710b8f3 100644
--- a/doc/scanimage.man
+++ b/doc/scanimage.man
@@ -4,36 +4,32 @@
scanimage \- scan an image
.SH SYNOPSIS
.B scanimage
-.RB [ \-d | \-\-device\-name
+.RB [ \-d
.IR dev ]
-.RB [ \-\-format
-.IR format ]
-.RB [ \-i | \-\-icc\-profile
+.RB [ \-\-format\fI=output-format ]
+.RB [ \-i
.IR profile ]
-.RB [ \-L | \-\-list\-devices ]
-.RB [ \-f | \-\-formatted\-device\-list
-.IR format ]
-.RB [ \-b | \-\-batch
+.RB [ \-L ]
+.RB [ \-f
+.IR device-format ]
+.RB [ \-b
.RI [ format ]]
-.RB [ \-\-batch\-start
-.IR start ]
-.RB [ \-\-batch\-count
-.IR count ]
-.RB [ \-\-batch\-increment
-.IR increment ]
+.RB [ \-\-batch\-start\fI=start ]
+.RB [ \-\-batch\-count\fI=count ]
+.RB [ \-\-batch\-increment\fI=increment ]
.RB [ \-\-batch\-double ]
.RB [ \-\-accept\-md5\-only ]
-.RB [ \-p | \-\-progress ]
-.RB [ \-o | \-\-output-file
+.RB [ \-p]
+.RB [ \-o
.IR path ]
-.RB [ \-n | \-\-dont\-scan ]
-.RB [ \-T | \-\-test ]
-.RB [ \-A | \-\-all-options ]
-.RB [ \-h | \-\-help ]
-.RB [ \-v | \-\-verbose ]
-.RB [ \-B | \-\-buffer-size
-.RI [= size ]]
-.RB [ \-V | \-\-version ]
+.RB [ \-n ]
+.RB [ \-T ]
+.RB [ \-A ]
+.RB [ \-h ]
+.RB [ \-v ]
+.RB [ \-B
+.RI size ]
+.RB [ \-V ]
.RI [ device\-specific\-options ]
.SH DESCRIPTION
.B scanimage
@@ -96,9 +92,9 @@ control of the backend code.
.PP
Parameters are separated by a blank from single-character options (e.g.
-.BI "\-d " epson )
+.BI "\-d " epson \fR)
and by a "=" from multi-character options (e.g.
-.BR \-\-device\-name =\fIepson\FR ).
+.BR \-\-device\-name =\fIepson \fR).
.TP
.BR \-d "\fI dev\fR, " \-\-device\-name =\fIdev\fR
@@ -117,12 +113,12 @@ If this variable is not set,
will attempt to open the first available device.
.TP
-.BR \-\-format =\fIformat\fR
+.BR \-\-format =\fIoutput-format\fR
selects how image data is written to standard output or the file specified by
the
.B \-\-output\-file
option.
-.I format
+.I output-format
can be
.BR pnm ,
.BR tiff ,
@@ -150,8 +146,8 @@ by its full device name. You may need to consult your system administrator to
find out the names of such devices.
.TP
-.BR \-f "\fI format\fR, " \-\-formatted\-device\-list =\fIformat\fR
-works similar to
+.BR \-f "\fI format\fR, " \-\-formatted\-device\-list =\fIdevice-format\fR
+works similarly to
.BR \-\-list\-devices ,
but requires a format string.
.B scanimage
@@ -232,7 +228,7 @@ is a specific command provided to aid this.
.B \-\-batch\-double
will automatically set the increment to 2.
Equivalent to
-.BR \-\-batch\-increment =2
+.BR \-\-batch\-increment =2.
.TP
.B \-\-batch\-prompt
@@ -301,17 +297,15 @@ standard output and no scan will be performed.
.TP
.BR \-v ", " \-\-verbose
increases the verbosity of the output of
-.B scanimage.
+.BR scanimage .
The option may be specified repeatedly, each time increasing the verbosity
level.
.TP
-.BR \-B " [\fIsize\fR], " \-\-buffer\-size =[\fIsize\fR]
-changes input buffer size from the default of 32KB to
-.I size
-KB. If
+.BR \-B " [\fIsize\fR], " \-\-buffer\-size =\fIsize
+changes input buffer size from the default of 1MB to
.I size
-is not specified then the buffer is set to 1 MB.
+KB.
.TP
.BR \-V ", " \-\-version
@@ -325,7 +319,7 @@ loads. If more information about the version
numbers of the backends are necessary, the
.B DEBUG
variable for the dll layer can be used. Example:
-.I "SANE_DEBUG_DLL=3 scanimage \-L" .
+.IR "SANE_DEBUG_DLL=3 scanimage \-L" .
.PP
As you might imagine, much of the power of
.B scanimage
@@ -507,8 +501,8 @@ to 127 characters.
.BR sane (7),
.BR gamma4scanimage (1),
.BR xscanimage (1),
-.BR xcam (1) ,
-.BR xsane (1) ,
+.BR xcam (1),
+.BR xsane (1),
.BR scanadf (1),
.BR sane\-dll (5),
.BR sane\-net (5),