hp-scan is a new feature with hplip that uses sane for scanning.
hp-scan is currently only implemented with a command line
interface. a GUI interface will be added in the future.
[SANE-DEVICE-URI]
SANE device
URI:
-d<sane_device_uri> or
--device=<sane_device_uri>
URI format:
hpaio:/<bus>/<model>?<identification>
[MODE] Enter graphical UI
mode:
-u or --gui
(Default)
Run in non-interactive
mode:
-n or
--non-interactive
[-n OPTIONS] (General) (Not applicable to GUI mode)
Scan
destinations:
-s<dest_list> or
--dest=<dest_list>
where <dest_list> is a comma separated list containing one or
more of:
'file'*,
'viewer', 'editor', 'pdf', 'fax', or 'print'. Use only commas between
values, no
spaces.
Scan
mode:
-m<mode> or --mode=<mode>. Where <mode> is 'color'*,
'gray' or
'lineart'.
Scanning
resolution:
-r<resolution_in_dpi> or --res=<resolution_in_dpi> or
--resolution=<resolution_in_dpi>
where <resolution_in_dpi> is 75, 150, 300, 600, 1200, 2400, 4800
(300 is
default).
Image
resize:
--resize=<scale_in_%> (min=1%, max=400%,
default=100%)
Image
contrast:
--contrast=<contrast>
ADF mode
(EXPERIMENTAL):
--adf (Note, only PDF output is supported when using the
ADF)
[-n OPTIONS] (Scan area) (Not applicable to GUI mode)
Specify the units for
area/box
-t<units> or
--units=<units>
measurements:
where <units> is 'mm'*, 'cm', 'in', 'px', or 'pt' ('mm' is
default).
Scan
area:
-a<tlx>,<tly>,<brx>,<bry> or
--area=<tlx>,<tly>,<brx>,<bry>
Coordinates are relative to the upper left corner of the scan
area.
Units for tlx, tly, brx, and bry are specified by -t/--units (default
is
'mm').
Use only commas between values, no
spaces.
Scan
box:
--box=<tlx>,<tly>,<width>,<height>
tlx and tly coordinates are relative to the upper left corner of the
scan
area.
Units for tlx, tly, width, and height are specified by -t/--units
(default is
'mm').
Use only commas between values, no
spaces.
Top left x of the scan
area:
--tlx=<tlx>
Coordinates are relative to the upper left corner of the scan
area.
Units are specified by -t/--units (default is
'mm').
Top left y of the scan
area:
--tly=<tly>
Coordinates are relative to the upper left corner of the scan
area.
Units are specified by -t/--units (default is
'mm').
Bottom right x of the scan
area:
--brx=<brx>
Coordinates are relative to the upper left corner of the scan
area.
Units are specified by -t/--units (default is
'mm').
Bottom right y of the scan
area:
--bry=<bry>
Coordinates are relative to the upper left corner of the scan
area.
Units are specified by -t/--units (default is
'mm').
Specify the scan area based on a
paper --size=<paper size
name>
size:
where <paper size name> is one of: 5x7, photo, a2_env, b4, b5,
3x5, 4x6, higaki, flsa, c6_env, legal,
no_10_env, exec, a3, a5, a4, letter, a6, super_b, oufufu-hagaki,
dl_env, japan_env_4, japan_env_3
[-n OPTIONS] ('file' dest) (Not applicable to GUI mode)
Filename for 'file'
destination:
-o<file> or -f<file> or --file=<file> or
--output=<file>
[-n OPTIONS] ('pdf' dest) (Not applicable to GUI mode)
PDF viewer
application:
--pdf=<pdf_viewer>
[-n OPTIONS] ('viewer' dest) (Not applicable to GUI mode)
Image viewer
application:
-v<viewer> or
--viewer=<viewer>
[-n OPTIONS] ('editor' dest) (Not applicable to GUI mode)
Image editor
application:
-e<editor> or
--editor=<editor>
[-n OPTIONS] ('email' dest) (Not applicable to GUI mode)
From: address for 'email'
dest:
--email-from=<email_from_address> (required for 'email'
dest.)
To: address for 'email'
dest:
--email-to=<email__to_address> (required for 'email'
dest.)
Email subject for 'email'
dest:
--email-subject="<subject>"
Use double quotes (") around the subject if it contains space
characters.
Note or message for the 'email'
dest: --email-msg="<msg>" or
--email-note="<note>"
Use double quotes (") around the note/message if it contains space
characters.
[-n OPTIONS] (advanced) (Not applicable to GUI mode)
Set the scanner compression
mode:
-x<mode> or --compression=<mode>, <mode>='raw',
'none' or 'jpeg' ('jpeg' is default) ('raw'
and
'none' are
equivalent)
[OPTIONS] Set the logging
level:
-l<level> or
--logging=<level>
<level>: none, info*, error, warn, debug
(*default)
Run in debug
mode:
-g (same as option:
-ldebug)
This help
information:
-h or
--help
Notes: 1. If no dest is provided, the 'file' dest will be automatically invoked. 2. If applications for viewer, editor, or pdf viewer are not provided, reasonable defaults will be used. 3. If --printer is not specified, the CUPS default will be used if available. 4. If an output file is not specified with the 'file' dest, a reasonable default will be used. 5. Some options may not be valid on some scanning devices. 6.
The following features are not yet implemented: GUI mode, batch
scanning, film/negative scanning, contrast adjustment, brightness
adjustment, autocrop, resize to axb, resize to xKB,
Examples:
Quickly (low-res) scan entire page
in $ hp-scan -n
-r75
color to
file:
Scan upper left 1in corner and send
as $ hp-scan -n --box=0,0,1,1 -tin
-semail --email-from=foo@bar.org
--email-to=bar@foo.org
email:
--email-note="Test scan" --email-subject="Test scan
email"
Scan entire page in 300dpi grayscale and
$
hp-scan -n -seditor
-mgray
then
edit:
Launch the hp-scan
GUI:
$
hp-scan
Scan into The
GIMP:
$ hp-scan -n --editor=gimp