From 6bff1fdf4bcd132e63be5d8afcf15b53ea74270a Mon Sep 17 00:00:00 2001 From: Henning Geinitz Date: Tue, 3 Oct 2006 18:39:35 +0000 Subject: [PATCH] Added examples on how to set the scan area in the manual page (bug #303802). Mention how to separate parameters from options in --help and manpage (bug #303819). --- ChangeLog | 4 ++++ doc/scanimage.man | 24 +++++++++++++++++++++++- frontend/scanimage.c | 2 ++ 3 files changed, 29 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index 6b89e3a4d..effc2bac8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,6 +2,10 @@ * doc/descriptions-external/hp3900.desc: Changed status of HP Scanjet 4370 to "minimal" (bug #303839). + * doc/scanimage.man frontend/scanimage.c: Added examples on how to + set the scan area in the manual page (bug #303802). Mention how + to separate parameters from options in --help and manpage (bug + #303819). 2006-09-24 Giuseppe Sacco diff --git a/doc/scanimage.man b/doc/scanimage.man index c6945bfd4..7eaa3cb90 100644 --- a/doc/scanimage.man +++ b/doc/scanimage.man @@ -1,4 +1,4 @@ -.TH scanimage 1 "23 Sep 2005" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.TH scanimage 1 "03 Oct 2006" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" .IX scanimage .SH NAME scanimage \- scan an image @@ -61,11 +61,19 @@ To scan with default settings to the file image.pnm: scanimage >image.pnm +To scan 100x100 mm to the file image.tiff (-x and -y may not be available with +all devices): + + scanimage -x 100 -y 100 --format=tiff >image.tiff + To print all available options: scanimage -h .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). + .PP The .B -d @@ -285,6 +293,20 @@ The documentation for the device-specific options printed by .B --help is best explained with a few examples: + -l 0..218mm [0] +.br + Top-left x position of scan area. +.PP +.RS +The description above shows that option +.B -l +expects an option value in the range from 0 to 218 mm. The +value in square brackets indicates that the current option value is 0 +mm. Most backends provide similar geometry options for top-left y position (-t), +width (-x) and height of scan-area (-y). +.RE + + --brightness -100..100% [0] .br Controls the brightness of the acquired image. diff --git a/frontend/scanimage.c b/frontend/scanimage.c index 2c7ffdc90..0dc568ae4 100644 --- a/frontend/scanimage.c +++ b/frontend/scanimage.c @@ -1822,6 +1822,8 @@ main (int argc, char **argv) Start image acquisition on a scanner device and write PNM image data to\n\ standard output.\n\ \n\ +Parameters are separated by a blank from single-character options (e.g.\n\ +-d epson) and by a \"=\" from multi-character options (e.g. --device-name=epson).\n\ -d, --device-name=DEVICE use a given scanner device (e.g. hp:/dev/scanner)\n\ --format=pnm|tiff file format of output file\n\ -i, --icc-profile=PROFILE include this ICC profile into TIFF file\n", prog_name);