diff --git a/man/scanadf.1.html b/man/scanadf.1.html new file mode 100644 index 00000000..2859fc2c --- /dev/null +++ b/man/scanadf.1.html @@ -0,0 +1,183 @@ + +
++ +scanadf(1) scanadf(1) + + ++
+ scanadf - acquire multiple images from a scanner equipped with an ADF + + ++
+ scanadf [-d|--device-name dev] [-h|--help] [-L|--list-devices] + [-v|--verbose] [-V|--version] [-o|--output-file name] [-S|--scan-script + name] [-s|--start-count num] [-e|--end-count num] [-r|--raw] [device- + specific-options] + + ++
+ scanadf is a command-line interface to control image acquisition + devices which are capable of returning a series of images (e.g. a scan- + ner with an automatic document feeder (ADF)). The device is controlled + via command-line options. After command-line processing, scanadf nor- + mally proceeds to acquire a series of images until the device returns + the SANE_STATUS_NO_DOCS status code. + + The images are written to output files, specified by the --output-file + option. These files are typically written in one of the PNM (portable + aNyMaP) formats (PBM for black-and-white images, PGM for grayscale + images, and PPM for color images). Several optional frame formats + (SANE_FRAME_JPEG, SANE_FRAME_G31D, SANE_FRAME_G32D, SANE_FRAME_G42D, + and SANE_FRAME_TEXT) are supported. In each case, the data is written + out to the output file as-is without a header. Unrecognized frame for- + mats are handled in the same way, although a warning message is printed + in verbose mode. + + Typically, the optional frame formats are used in conjunction with a + scan script (specified by the --scanscript option) which is invoked for + each acquired image. The script is provided with a series of environ- + ment variables which describe the parameters and format of the image + file. + + scanadf accesses image acquisition devices through the SANE (Scanner + Access Now Easy) interface and can thus support any device for which + there exists a SANE backend (try "apropos sane-" to get a list of + available backends). + + ++
+ The -d or --device-name options must be followed by a SANE device-name. + A (partial) list of available devices can be obtained with the --list- + devices option (see below). If no device-name is specified explicitly, + scanadf will attempt to open the first available device. + + The -h or --help options request help information. The information is + printed on standard output and in this case, no attempt will be made to + acquire an image. + + The -L or --list-devices option requests a (partial) list of devices + that are available. The list is not complete since some devices may be + available, but are not listed in any of the configuration files (which + are typically stored in directory /usr/local/etc/sane.d). This is par- + ticularly the case when accessing scanners through the network. If a + device is not listed in a configuration file, the only way to access it + is by its full device name. You may need to consult your system admin- + istrator to find out the names of such devices. + + The -v or --verbose options increase the verbosity of the operation of + scanadf. The option may be specified repeatedly, each time increasing + the verbosity level. + + The -V or --version option requests that scanadf print the program and + package name, as well as the version number of the SANE distribution + that it came with. + + The -o or --output-file option specifies a format string used to gener- + ate the name of file to write the image data to. You can use %d + replacement in the output file name; this will be replaced with the + current page number. The default format string is image-%04d. + + The -S or --scan-script option specifies the name of script to run + after each scanned image is acquired. The script receives the name of + the image output file as its first and only command line argument. + Additionally the scan script can reference the following environment + variables to get information about the parameters of the image. + + SCAN_RES - the image resolution (in DPI) + SCAN_WIDTH - the image width (in pixels) + SCAN_HEIGHT - the image height (in pixels) + SCAN_DEPTH - the image bit-depth (in bits) + SCAN_FORMAT - a string representing the image format (e.g. gray, + g42d, text, etc) + SCAN_FORMAT_ID - the numeric image format identifier + + The -s or --start-count option specifies the page number of first + scanned image. + + The -e or --end-count option specifies the last page number to scan. + Using this option, you can request a specific number of pages to be + scanned, rather than scanning until there are no more images available. + + The -r or --raw option specifies that the raw image data be written to + the output file as-is without interpretation. This disables the writ- + ing of the PNM header for basic frame types. This feature is usually + used in conjunction with the --scan-script option where the scan script + uses the environment variables to understand the format and parameters + of the image and converts the file to a more useful format. NOTE: With + support for the optional frame types and the default handling of unrec- + ognized frametypes, this option becomes less and less useful. + + As you might imagine, much of the power of scanadf comes from the fact + that it can control any SANE backend. Thus, the exact set of command- + line options depends on the capabilities of the selected device. To + see the options for a device named dev, invoke scanadf via a command- + line of the form: + + scanadf --help --device dev + + The documentation for the device-specific options printed by --help is + explained in the manual page for scanimage. + + ++
+ /usr/local/etc/sane.d + This directory holds various configuration files. For details, + please refer to the manual pages listed below. + + ++
+ scanimage(1), xscanimage(1), sane(7) + + ++
+ scanadf is an adaptation by Tom Martone of scanimage by David Mos- + berger, Andreas Beck, and Gordon Matzigkeit following closely the + features of bnhscan by Sean Reifschneider of tummy.com, ltd. + + ++
+ Please send reports to sane-devel@alioth-lists.debian.net. + + This program relies on the backend to return the SANE_STATUS_NO_DOCS + status code when the automatic document feeder is out of paper. Use of + this program with backends that do not support ADFs (e.g. flatbed scan- + ners) will likely result in repeated scans of the same document. In + this case, it is essential to use the start-count and end-count to con- + trol the number of images acquired. + + Only a subset of the SANE backends support feeders and return SANE_STA- + TUS_NO_DOCS appropriately. Backends which are known to work at this + time are: + + sane-bh - Bell+Howell Copiscan II series scanners. + sane-hp - Hewlett Packard scanners. A patch to the sane-hp + backend is necessary. The --scantype=ADF option must be speci- + fied (earlier versions of the backend used the --scan-from-adf + option, instead). + sane-umax - UMAX scanners. Support exists in build 12 and + later. The --source="Automatic Document Feeder" option must be + specified. + + 15 Sep 1999 scanadf(1) ++
+ +xcam(1) xcam(1) + + ++
+ xcam - a graphical camera frontend for SANE + + ++
+ xcam + + ++
+ Should be straightforward to use. Just be sure to use a very recent + version of GTK. + + ++
+ $HOME/.sane/xcam/devicename.rc + For each device, there is one rc-file that holds the saved set- + tings for that particular device. Normally, this file should + not be manipulated directly. Instead, the user should use the + xcam interface to select appropriate values and then save the + device settings using the "Preferences->Save as default set- + tings" menubar entry. + + ++
+ sane(7), xscanimage(1), scanimage(1), sane-dll(5) and the backend man- + pages + + ++
+ David Mosberger-Tang + + 24 Jun 2000 xcam(1) ++
+ +xscanimage(1) xscanimage(1) + + ++
+ xscanimage - scan an image + + ++
+ xscanimage [--version|-V] [--help|-h] [--display d] [--no-xshm] + [--sync] [devicename] + + ++
+ xscanimage provides a graphical user-interface to control an image + acquisition device such as a flatbed scanner or a camera. It allows + previewing and scanning invidual images and can be invoked either + directly from the command-line or through The GIMP image manipulation + program. In the former case, xscanimage acts as a stand-alone program + that saves acquired images in a suitable PNM format (PBM for black-and- + white images, PGM for grayscale images, and PPM for color images). In + the latter case, the images are directly passed to The GIMP for further + processing. + + xscanimage accesses image acquisition devices through the SANE (Scanner + Access Now Easy) interface. The list of available devices depends on + installed hardware and configuration. When invoked without an explicit + devicename argument, xscanimage presents a dialog listing of all known + and available devices. If the environment variable SANE_DEFAULT_DEVICE + is set to the devicename, the device is preselected in the dialog. To + access an available device that is not known to the system, the device- + name must be specified explicitly. The format of devicename is backend- + name:devicefile (e.g. umax:/dev/sga). + + ++
+ To run xscanimage under the gimp(1), simply copy it to one of the + gimp(1) plug-ins directories. If you want to conserve disk-space, you + can create a symlink instead. For example, for gimp-1.0.x the command + + ln -s /usr/local/bin/xscanimage ~/.gimp/plug-ins/ + + and for gimp-1.2.x the command + + ln -s /usr/local/bin/xscanimage ~/.gimp-1.2/plug-ins/ + + adds a symlink for the xscanimage binary to the user's plug-ins direc- + tory. After creating this symlink, xscanimage will be queried by + gimp(1) the next time it's invoked. From then on, xscanimage can be + invoked through "File->Acquire->Xscanimage->Device dialog..." menu + entry. + + You'll also find that the "File->Acquire->Xscanimage" menu contains + short-cuts to the SANE devices that were available at the time xscanim- + age was queried. For example, the first PNM pseudo-device is typically + available as the short-cut "File->Acquire->Xscanimage->pnm:0". Note + that gimp(1) caches these short-cuts in ~/.gimp/pluginrc. Thus, when + the list of available devices changes (e.g., a new scanner is + installed), then it is typically desirable to rebuild this cache. To + do this, you can either touch(1) the xscanimage binary (e.g., "touch + /usr/local/bin/xscanimage") or delete the plug-ins cache (e.g., "rm + ~/.gimp/plug-ins"). Either way, invoking gimp(1) afterwards will cause + the pluginrc to be rebuilt. + + ++
+ If the --version (-V) option is given, xscanimage will output its ver- + sion number. + + The --help (-h) flag prints a short summary of options. + + The --display flag selects the X11 display used to present the graphi- + cal user-interface (see X(1) for details). + + The --no-xshm flag requests not to use shared memory images. Shared + memory images usually enhance performance but cause problems with some + buggy X11 servers. Unless your X11 server dies when running this pro- + gram, there is no need or advantage to specify this flag. + + The --sync flag requests a synchronous connection with the X11 server. + This is for debugging purposes only. + + ++
+ SANE_DEFAULT_DEVICE + The default device-name. Example: + SANE_DEFAULT_DEVICE="hp:/dev/scanner". + + SANE_DEBUG_XSCANIMAGE + This environment variable controls the debug level xscanimage. + Higher debug levels increase the verbosity of the output. + + Value Descsription + 0 print fatal errors + 1 print errors + 2 print warnings + 3 print information messages + 4 print everything + + Example: + SANE_DEBUG_XSCANIMAGE=3 + + ++
+ $HOME/.sane/xscanimage/xscanimage.rc + This files holds the user preferences. Normally, this file + should not be manipulated directly. Instead, the user should + customize the program through the "Preferences" dialog. + + $HOME/.sane/xscanimage/devicename.rc + For each device, there is one rc-file that holds the saved set- + tings for that particular device. Normally, this file should + not be manipulated directly. Instead, the user should use the + xscanimage interface to select appropriate values and then save + the device settings using the "Preferences->Save Device Set- + tings" menubar entry. + + $HOME/.sane/preview-devicename.ppm + After acquiring a preview, xscanimage normally saves the preview + image in this device-specific file. Thus, next time the program + is started up, the program can present the old preview image. + This feature can be turned off through the "Preferences->Preview + Options..." dialog. + + /usr/local/share/sane-style.rc + This system-wide file controls the aspects of the user-interface + such as colors and fonts. It is a GTK style file and provides + fine control over the visual aspects of the user-interface. + + $HOME/.sane/sane-style.rc + This file serves the same purpose as the system-wide style file. + If present, it takes precedence over the system wide style file. + + ++
+ sane(7), gimp(1), xcam(1), scanimage(1), scanadf(1), sane-scsi(5), + sane-dll(5), sane-net(5), sane-"backendname"(5) + + ++
+ Tristan Tarrant, Andreas Beck, David Mosberger, and Henning Meier- + Geinitz + + 1 Feb 2003 xscanimage(1) ++