Debian Codegraph @

upstream/debian-unstable/man5/sane-hs2p.5

raw
1 .TH sane\-hs2p 5 "13 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-hs2p
3 .SH NAME
4 sane\-hs2p \- SANE backend for Ricoh SCSI flatbed/ADF scanners
5 .SH DESCRIPTION
6 The
7 .B sane\-hs2p
8 library implements a SANE (Scanner Access Now Easy) backend that provides
9 access to the Ricoh IS450 family of scanners. Should also work with the IS420,
10 IS410, and IS430 scanners, but these are untested.
11 Please contact the maintainer or the sane\-devel mailing list if you own such a scanner.
12 .PP
13 This backend is alpha-quality. It may have bugs and some scanners haven't been
14 tested at all. Be careful and pull the plug if the scanner causes unusual
15 noise.
16
17 .SH "DEVICE NAMES"
18 This backend expects device names of the form:
19 .PP
20 .RS
21 .I special
22 .RE
23 .PP
24 Where
25 .I special
26 is the path-name for the special device that corresponds to a SCSI
27 scanner. The program
28 .BR sane\-find\-scanner (1)
29 helps to find out the correct device. Under Linux, such a device name could be
30 .I /dev/sg0
31 or
32 .IR /dev/sga ,
33 for example. See
34 .BR sane\-scsi (5)
35 for details.
36
37 .SH CONFIGURATION
38 The contents of the
39 .I hs2p.conf
40 file is a list of device names that correspond to SCSI
41 scanners. Empty lines and lines starting with a hash mark (#) are
42 ignored. See
43 .BR sane\-scsi (5)
44 on details of what constitutes a valid device name.
45
46 .SH FILES
47 .TP
48 .I /etc/sane.d/hs2p.conf
49 The backend configuration file (see also description of
50 .B SANE_CONFIG_DIR
51 below).
52 .TP
53 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-hs2p.a
54 The static library implementing this backend.
55 .TP
56 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-hs2p.so
57 The shared library implementing this backend (present on systems that
58 support dynamic loading).
59 .SH ENVIRONMENT
60 .TP
61 .B SANE_CONFIG_DIR
62 This environment variable specifies the list of directories that may
63 contain the configuration file. On *NIX systems, the directories are
64 separated by a colon (`:'), under OS/2, they are separated by a
65 semi-colon (`;'). If this variable is not set, the configuration file
66 is searched in two default directories: first, the current working
67 directory (".") and then in
68 .IR /etc/sane.d .
69 If the value of the
70 environment variable ends with the directory separator character, then
71 the default directories are searched after the explicitly specified
72 directories. For example, setting
73 .B SANE_CONFIG_DIR
74 to "/tmp/config:" would result in directories
75 .IR tmp/config ,
76 .IR . ,
77 and
78 .I "/etc/sane.d"
79 being searched (in this order).
80 .TP
81 .B SANE_DEBUG_HS2P
82 If the library was compiled with debug support enabled, this
83 environment variable controls the debug level for this backend.
84 A value of 255 prints all debug output. Smaller values reduce verbosity.
85
86 .SH CURRENT STATUS
87 The
88 .B sane\-hs2p
89 backend is now in version 1.00. All major scanning-related features
90 are supported, except for those features requiring the optional IPU. Scanning
91 from the flatbed or ADF (either simplex or duplex) is supported. Lineart,
92 halftone, 4-bit gray, and 8-bit gray are supported. Pre-set gamma tables and
93 halftone patterns are supported, as well as brightness, threshold, contrast.
94 Also supported is scan wait mode, binary and gray filtering, negative scanning,
95 and absolute or relative white setting. Printing with the optional endorser
96 also is supported.
97
98 .SH PLANNED FUNCTIONALITY
99 This scanner can scan from the ADF in continuous simplex mode.
100 Surprisingly, many scanners scan an entire document from the ADF
101 into memory before ejecting the sheet. Thus if the document is too
102 long, the scanner cannot hold the entire image data in memory.
103 But if the scanner would send its image data when its memory got full,
104 and then read the next buffer's worth of data, continuous scanning
105 could be achieved.
106
107 .SH MISSING FUNCTIONALITY
108 The SCSI commands for uploading (2AH) or downloading (28H)
109 custom halftone patterns (02H) and gamma vectors (03H) should work,
110 but require implementing the SANE Option-Value code to allow the
111 user to create the tables to be uploaded to the scanner. No support
112 for Maintenance Data (80H) is planned as this functionality is more
113 suited to a stand-alone utility to be used by a technician when
114 replacing the lamp or ADF unit. Nor is support for reading or changing
115 IPU (93H) parameters and adjustments planned, since my IS450 lacks
116 such a unit. The 31-byte Auto Photo/Letter struct and 21-byte Dynamic
117 threshold struct are documented in the
118 .I hs2p-scsi.h
119 file should someone wish to use their IPU for image data processing.
120
121 .SH "SEE ALSO"
122 .BR sane (7),
123 .BR sane\-find\-scanner (1),
124 .BR sane\-scsi (5),
125
126 .SH AUTHOR
127 jeremy
128 .RI < [email protected] >
129 .br
130 Maintained by Jeremy Johnson
131 .RI < [email protected] >