Debian Codegraph @

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

raw
1 .TH sane\-gphoto2 5 "11 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-gphoto2
3 .SH NAME
4 sane\-gphoto2 \- SANE backend for gphoto2 supported cameras
5 .SH DESCRIPTION
6 The
7 .B sane\-gphoto2
8 library implements a SANE (Scanner Access Now Easy) backend that
9 provides access to the digital cameras supported by gphoto2.
10 This backend has only been tested with a handful of cameras so far. Patches
11 to support other models are welcome.
12 .PP
13 Because of the limited testing of this backend, it is commented out
14 in
15 .I /etc/sane.d/dll.conf
16 by default. Either the comment
17 character must be removed or the backend must be called explicitly.
18 E.g.
19 .I "scanimage \-d gphoto2"
20 or
21 .IR "xscanimage gphoto2" .
22 .SH "DEVICE NAMES"
23 The current version of the backend only allows one camera to be
24 connected. The device name is always "0".
25 .SH CONFIGURATION
26 The contents of the
27 .I gphoto2.conf
28 specify the characteristics of the camera to be used. Resolutions
29 (high resolution, low resolution, and thumbnail size) are
30 required since they are needed by the sane frontends, but can't be obtained
31 through the gphoto2 interface. Valid ports and cameras can be obtained
32 by
33 .I "gphoto2 \-\-list\-cameras"
34 and
35 .IR "gphoto2 \-\-list\-ports" .
36 .PP
37 The
38 .B dumpinquiry
39 line causes some information about the camera to be printed.
40 .PP
41 Empty lines and lines starting with a hash mark (#) are
42 ignored. A sample configuration file is shown below:
43 .PP
44 The
45 .B topfolder
46 line specifies the "fixed" part of the file path. For
47 example, on the Kodak DC-240, files are stored in the directory
48 .IR /DCIM/100DC240.
49 The
50 .I /DCIM
51 portion is constant, but 100DC240 will change and must be read from the camera.
52 In this case, the line would read "topfolder=/DCIM"
53 .PP
54 Some cameras don't implement a file structure and store all pictures
55 in the
56 .I "/"
57 directory. This is indicated by setting "subdirs=0" with
58 "topfolder=/"
59 .PP
60 .RS
61 port=usb:
62 .br
63 camera=Kodak DC240
64 .br
65 # this is a comment
66 .br
67 high_resolution=1280x960
68 .br
69 low_resolution=640x480
70 .br
71 thumb_resolution=160x120
72 .br
73 dumpinquiry
74 .RE
75 .PP
76 .SH FILES
77 .TP
78 .I /etc/sane.d/gphoto2.conf
79 The backend configuration file (see also description of
80 .B SANE_CONFIG_DIR
81 below).
82 .TP
83 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-gphoto2.a
84 The static library implementing this backend.
85 .TP
86 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-gphoto2.so
87 The shared library implementing this backend (present on systems that
88 support dynamic loading).
89
90 .SH ENVIRONMENT
91 .TP
92 .B SANE_CONFIG_DIR
93 This environment variable specifies the list of directories that may
94 contain the configuration file. On *NIX systems, the directories are
95 separated by a colon (`:'), under OS/2, they are separated by a
96 semi-colon (`;'). If this variable is not set, the configuration file
97 is searched in two default directories: first, the current working
98 directory
99 .RI ( "." )
100 and then in
101 .IR /etc/sane.d .
102 If the value of the
103 environment variable ends with the directory separator character, then
104 the default directories are searched after the explicitly specified
105 directories. For example, setting
106 .B SANE_CONFIG_DIR
107 to "/tmp/config:" would result in directories
108 .IR "tmp/config" ,
109 .IR "." ,
110 and
111 .I "/etc/sane.d"
112 being searched (in this order).
113 .TP
114 .B SANE_DEBUG_GPHOTO2
115 If the library was compiled with debugging support enabled, this
116 environment variable controls the debug level for this backend.
117 A value of 128 requests maximally copious debug output; smaller
118 levels reduce verbosity.
119 .TP
120 .B GP_DEBUG
121 Set to 1, 2, or 3, to enable various levels of debugging within the
122 gphoto2 libraries.
123
124 .SH "SEE ALSO"
125 .BR sane (7),
126 .BR scanimage (1),
127 .BR xscanimage (1),
128 .BR libgphoto2 (3)
129
130 .SH AUTHOR
131 Peter S. Fales
132
133 .PP
134 The manpage was largely copied from the
135 .BR sane\-dc210 (5)
136 manpage.
137
138 .SH BUGS
139 Many, no doubt.
140 .PP
141 More general comments, suggestions, and inquiries about frontends
142 or SANE should go to the SANE Developers mailing list
143 (see
144 .I http://www.sane\-project.org/mailing\-lists.html
145 for details).
146 You must be subscribed to the list, otherwise your mail won't be
147 sent to the subscribers.