summaryrefslogtreecommitdiff
path: root/doc/sane-pnm.man
blob: 80c81fef2757d1316243b59ccfc860955d9a9cdc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
.TH sane\-pnm 5 "14 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
.IX sane\-pnm
.SH NAME
sane\-pnm \- SANE PNM image reader pseudo-backend

.SH DESCRIPTION
The
.B sane\-pnm
library implements a SANE (Scanner Access Now Easy) backend that
provides access to PNM (Portable aNyMap files, which covers PBM bitmap
files, PGM grayscale files, and PPM pixmap files).  The purpose of
this backend is primarily to aid in debugging of SANE frontends.  It
also serves as an illustrative example of a minimal SANE backend.
.SH "DEVICE NAMES"
This backend provides two devices called
.B 0
and
.BR 1.

.SH CONFIGURATION
No configuration required.
.SH FILES
.TP
.I @LIBDIR@/libsane\-pnm.a
The static library implementing this backend.
.TP
.I @LIBDIR@/libsane\-pnm.so
The shared library implementing this backend (present on systems that
support dynamic loading).

.SH ENVIRONMENT
.TP
.B SANE_DEBUG_PNM
If the library was compiled with debug support enabled, this
environment variable controls the debug level for this backend.  E.g.,
a value of 128 requests all debug output to be printed.  Smaller
levels reduce verbosity.

.SH BUGS
If the
.B sane\-pnm
backend is installed and
.BR saned (8)
is used to allow users on remote
computers to scan on the local machine, PNM files can be read by the remote
user. This is limited to the files
.BR saned (8)
can access (usually it's running as
user "sane"). All PNM files can be read if
.BR saned (8)
runs as root which isn't
recommended anyway. The
.B sane\-pnm
backend is disabled by default. If you want to use it, enable it with configure (see
.I configure \-\-help
for details). Be sure that
only trusted users can access the
.B sane\-pnm
backend over
.BR saned (8).

.SH AUTHOR
Andreas Beck, Gordon Matzigkeit, and David Mosberger

.SH SEE ALSO
.BR sane (7),
.BR saned (8)