Debian Codegraph @

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

raw
1 .TH sane\-dll 5 "13 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-dll
3 .SH NAME
4 sane\-dll \- SANE dynamic backend loader
5 .SH DESCRIPTION
6 The
7 .B sane\-dll
8 library implements a SANE (Scanner Access Now Easy) backend that
9 provides access to an arbitrary number of other SANE backends. These
10 backends may either be pre-loaded at the time the
11 .B sane\-dll
12 library is built or, on systems that support dynamic loading of shared
13 libraries, the backends may be loaded at runtime. In the latter case,
14 adding support for a new backend simply involves installing the
15 relevant library in
16 .I /usr/lib/x86_64-linux-gnu/sane
17 and adding an entry to the
18 .I dll.conf
19 configuration file. In other words, no applications need to be
20 modified or recompiled to add support for new devices.
21 .SH "DEVICE NAMES"
22 This backend expects device names of the form:
23 .PP
24 .RS
25 .IR backend : device
26 .RE
27 .PP
28 Where
29 .I backend
30 is the name of the backend and
31 .I device
32 is the name of the device in this backend that should be addressed.
33 If the device name does not contain a colon (:), then the entire string
34 is treated as the
35 .I device
36 string for the default backend. The default backend is the backend
37 listed last in the configuration file (see below) or the first
38 pre-loaded backend (if any).
39 .SH CONFIGURATION
40 The contents of the
41 .I dll.conf
42 file is a list of backend names that may be loaded dynamically upon demand.
43 Empty lines are ignored, also everything after a hash mark (#). A sample
44 configuration file is shown below:
45 .PP
46 .RS
47 net
48 .br
49 # this is a comment
50 .br
51 pnm
52 .br
53 mustek
54 .RE
55 .PP
56 It is also possible to add a file in
57 .I /etc/sane.d/dll.d
58 that contains the list of backends to be added. Backends mentioned in a
59 file included in this directory will be added before any backends listed
60 in
61 .I dll.conf.
62 Files in
63 .I /etc/sane.d/dll.d
64 can be freely named. They shall follow the format conventions as apply for
65 .I dll.conf.
66
67 .PP
68 Note that backends that were pre-loaded when building this library do
69 not have to be listed in this configuration file. That is, if a
70 backend was preloaded, then that backend will always be present,
71 regardless of whether it's listed in the configuration file or not.
72 .PP
73 The list of preloaded backends is determined by macro
74 .B PRELOADABLE_BACKENDS
75 in file backend/Makefile.in of the SANE source code distribution. After
76 changing the value of this macro, it is necessary to reconfigure, rebuild,
77 and reinstall SANE for the change to take effect.
78
79 Aliases are defined in the config file
80 .IR dll.aliases .
81 It can contain entries of the form
82 .PP
83 .RS
84 .br
85 alias SomeName SaneDeviceName
86 .br
87 alias "Some Name" SaneDeviceName
88 .br
89 hide SaneDeviceName
90 .RE
91 .PP
92 For example:
93
94 .PP
95 .RS
96 .br
97 alias Epson net:somehost:epson:/dev/sgX
98 .br
99 alias "Siemens ST400" st400:/dev/sgY
100 .br
101 hide net:somehost:pnm:0
102 .br
103 hide net:somehost:pnm:1
104 .br
105 alias "Read from file" pnm:0
106 .br
107 hide pnm:1
108 .RE
109 .PP
110
111 Aliased device names are automatically hidden.
112
113 The idea is that users don't have to deal with complicated device
114 names (especially for networked devices), and to hide other exported
115 devices which might confuse them. Note that a hidden device can still
116 be accessed if the device name is known, it just doesn't appear on the
117 list.
118
119 .SH FILES
120 .TP
121 .I /etc/sane.d/dll.aliases
122 The list of aliased or hidden backends.
123 .TP
124 .I /etc/sane.d/dll.conf
125 The backend configuration file (see also description of
126 .B SANE_CONFIG_DIR
127 below).
128 .TP
129 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-dll.a
130 The static library implementing this backend.
131 .TP
132 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-dll.so
133 The shared library implementing this backend (present on systems that
134 support dynamic loading).
135 .SH ENVIRONMENT
136 .TP
137 .B SANE_CONFIG_DIR
138 This environment variable specifies the list of directories that may
139 contain the configuration file. On *NIX systems, the directories are
140 separated by a colon (`:'), under OS/2, they are separated by a
141 semi-colon (`;'). If this variable is not set, the configuration file
142 is searched in two default directories: first, the current working
143 directory (".") and then in
144 .IR /etc/sane.d .
145 If the value of the environment variable ends with the directory
146 separator character, then the default directories are searched after
147 the explicitly specified directories. For example, setting
148 .B SANE_CONFIG_DIR
149 to "/tmp/config:" would result in directories
150 .IR tmp/config ,
151 .IR . ,
152 and
153 .I "/etc/sane.d"
154 being searched (in this order).
155 .TP
156 .B SANE_DEBUG_DLL
157 If the library was compiled with debug support enabled, this
158 environment variable controls the debug level for this backend. E.g.,
159 a value of 128 requests all debug output to be printed. Smaller
160 levels reduce verbosity.
161
162 .ft CR
163 .nf
164 Value Description
165 0 print severe errors only
166 1 print normal errors and important messages
167 2 print normal messages
168 3 print debugging messages
169 4 print everything
170 .fi
171 .ft R
172
173 Example:
174 export SANE_DEBUG_DLL=3
175
176
177 .SH "SEE ALSO"
178 .BR sane (7),
179 .BR scanimage (1),
180 .BR sane\-"backendname" (5)
181
182 .SH AUTHOR
183 David Mosberger