1GPHOTO2(1) The gPhoto2 Reference (the man GPHOTO2(1)
2
6 gphoto2 - command-line gphoto2 client
7
9 gphoto2 [--debug] [--debug-logfile FILENAME] [[-q] [--quiet]] [[-v]
10 [--verbose]] [[-h] [--help]]
11 [--hook-script FILENAME]
12 [--list-cameras] [--list-ports] [--stdout] [--stdout-size]
13 [--auto-detect] [--port PATH] [--speed SPEED] [--camera MODEL]
14 [--filename FILENAME]
15 [--usbid USBIDS]
16 [[-a] [--abilities]]
17 [[--folder FOLDER] [-f FOLDER]] [[[-R] [--recurse]]
18 [--no-recurse]] [[-l] [--list-folders]]
19 [[-L] [--list-files]] [[-m NAME] [--mkdir NAME]]
20 [[-r NAME] [--rmdir NAME]] [[-n] [--num-files]]
21 [[-p RANGE] [--get-file RANGE]] [[-P] [--get-all-files]]
22 [[-t RANGE] [--get-thumbnail RANGE]]
23 [[-T] [--get-all-thumbnails]]
24 [--get-raw-data RANGE] [--get-all-raw-data]
25 [--get-audio-data RANGE] [--get-all-audio-data]
26 [--force-overwrite]
27 [--new]
28 [[-d RANGE] [--delete-file RANGE]] [[-D] [--delete-all-files]]
29 [[-u FILENAME] [--upload-file FILENAME]] [--config]
30 [--list-config]
31 [--get-config CONFIGENTRY]
32 [--set-config CONFIGENTRY=CONFIGVALUE]
33 [--capture-preview]
34 [[-F COUNT] [--frames COUNT]] [[-I SECONDS]
35 [--interval SECONDS]] [--capture-image] [--capture-movie]
36 [--capture-sound]
37 [--show-info RANGE]
38 [--show-exif RANGE]
39 [--summary] [--manual] [--about] [--shell]
40
42 libgphoto2(3) is a cross-platform digital camera library, and
43 gphoto2(1) is a command-line client for it.
44 Where an option takes a RANGE of files, thumbnails, or other data, they
46 are numbered beginning at 1. A range is a comma-separated list of
47 numbers or spans (“first-last”). Ranges are XOR (exclusive or), so that
48 “1-5,3,7” is equivalent to “1,2,4,5,7”.
49 --debug
51 Turn on debugging output. Debugging output is written to stderr
52 by default, or to the filename given to the --debug-logfile
53 option.
54 --debug-logfile FILENAME (since 2.3.0)
56 The logfile to write the debugging info to, if --debug is given.
57 --hook-script FILENAME (new after 2.3.0)
59 Hook script to execute when something has happened. The hook
60 script reads the environment variable ACTION.
61 ACTION=init
63 indicates that gphoto2 has just initialized. If the hook
64 script returns with a non-zero exit code now, gphoto2
65 will abort.
66 ACTION=start
68 indicates that gphoto2 has finished parsing the command
69 line and ise about to execute the requested commands.
70 ACTION=download
72 indicates that a file has just been downloaded to the
73 computer and stored in the file indicated by the
74 environment variable ARGUMENT.
75 ACTION=stop
77 indicates that gphoto2 is about to finish.
78 -q, --quiet
80 Quiet output (default=verbose).
81 -v, --version
83 Display version and exit.
84 -h, --help
86 Display a short usage message.
87 --list-cameras
89 List supported camera models.
90 --list-ports
92 List supported port devices.
93 --stdout
95 Send file to stdout.
96 --stdout-size
98 Print filesize before data.
99 --auto-detect
101 List auto-detected cameras and the ports to which they are
102 connected.
103 --port PATH
105 Specify port device. The --list-ports prints a list of valid,
106 usable ports. In case of multiple USB cameras, the --auto-detect
107 shows you the specific port each camera is connected to.
108 --speed SPEED
110 Specify serial transfer speed.
111 --camera MODEL
113 Specify camera model. The --list-cameras option prints a list of
114 all explicitly supported cameras.
115 Most model names contain spaces: remember to enclose the name in
117 quotes so that the shell knows it is one parameter. For example:
118 --camera "Kodak DC240".
119 Note that if you specify --camera, you must also specify --port.
121 Otherwise the --camera option will be silently ignored.
122 --filename FILENAME
124 When downloading files from the camera, specify the file name or
125 file name pattern to use when storing the downloaded file on the
126 local disk. When uploading a file to the camera, specify the
127 filename to store the uploaded file as on the camera.
128 The --filename option accepts %a, %A, %b, %B, %d, %H, %k, %I,
130 %l, %j, %m, %M, %S, %y, %%, (see date(1)) and, in addition, %n
131 for the number, %C for the filename suffix, %f for the filename
132 without suffix, %: for the complete filename in lowercase.
133 Note that %: is still in alpha stage, and the actual character
135 or syntax may still be changed. E.g. it might be possible to use
136 %#f and %#C for lower case versions, and %^f and %^C for upper
137 case versions.
138 %n is the only conversion specifier to accept a padding
140 character and width: %03n will pad with zeros to width 3 (e.g.
141 print the number 7 as “007”). Leaving out the padding character
142 (e.g. %3n) will use an implementation specific default padding
143 character which may or may not be suitable for use in file
144 names.
145 --usbid USBIDS
147 (Expert only) Override USB IDs.
148 USBIDSmust be of the form
149 DetectedVendorID:DetectedProductID=TreatAsVendorID:TreatAsProductID
150 to treat any USB device detected as
151 DetectedVendorID:DetectedProductID as
152 TreatAsVendorID:TreatAsProductID instead. All the VendorIDs and
153 ProductIDs should be hexadecimal numbers beginning in C
154 notation, i.e. beginning with '0x'.
155 Example: --usbid 0x4a9:0x306b=0x4a9:0x306c
157 -a, --abilities
159 Display camera abilities.
160 -f, --folder FOLDER
162 Specify camera folder (default="/").
163 -R, --recurse
165 Recursion (default for download).
166 --no-recurse
168 No recursion (default for deletion).
169 -l, --list-folders
171 List folders in folder.
172 -L, --list-files
174 List files in folder.
175 -m, --mkdir NAME
177 Create a directory.
178 -r, --rmdir NAME
180 Remove a directory.
181 -n, --num-files
183 Display number of files.
184 -p, --get-file RANGE
186 Get files given in range.
187 -P, --get-all-files
189 Get all files from folder.
190 -t, --get-thumbnail RANGE
192 Get thumbnails given in range.
193 -T, --get-all-thumbnails
195 Get all thumbnails from folder.
196 --get-raw-data RANGE
198 Get raw data given in range.
199 --get-all-raw-data
201 Get all raw data from folder.
202 --get-audio-data RANGE
204 Get audio data given in range.
205 --get-all-audio-data
207 Get all audio data from folder.
208 --force-overwrite
210 Overwrite files without asking.
211 --new Only get not already downloaded files. This option depends on
213 camera support of flagging already downloaded images and is not
214 available for all drivers.
215 -d, --delete-file RANGE
217 Delete files given in range.
218 -D, --delete-all-files
220 Delete all files in folder.
221 -u, --upload-file FILENAME
223 Upload a file to camera.
224 --capture-preview
226 Capture a quick preview.
227 -F COUNT, --frames COUNT
229 Number of frames to capture in one run. Default is infinite
230 number of frames.
231 -I SECONDS, --interval SECONDS
233 Time between capture of multiple frames.
234 --capture-image
236 Capture an image.
237 --capture-movie
239 Capture a movie.
240 --capture-sound
242 Capture an audio clip.
243 --show-info RANGE
245 Show info.
246 --list-config
248 List all configuration entries.
249 --get-config CONFIGENTRY
251 Get the specified configuration entry.
252 --set-config CONFIGENTRY=CONFIGVALUE
254 Set the specified configuration entry.
255 --summary
257 Summary of camera status.
258 --manual
260 Camera driver manual.
261 --about
263 About the camera driver.
264 --shell
266 Start the gphoto2 shell, an interactive environment. See SHELL
267 MODEfor a detailed description.
268
270 The following commands are available:
271 cd Change to a directory on the camera.
273 ls List the contents of the current directory on the camera.
275 lcd Change to a directory on the local machine.
277 get Download the file to the current directory.
279 get-thumbnail
281 Download the thumbnail to the current directory.
282 get-raw
284 Download raw data to the current directory.
285 show-info
287 Show information.
288 delete Delete a file or directory.
290 show-exif
292 Show EXIF information (only if compiled with EXIF support).
293 help, ?
295 Displays command usage.
296 exit, quit, q
298 Exit the gphoto2 shell.
299
301 CAMLIBS
302 If set, defines the directory where the libgphoto2 library looks
303 for its camera drivers (camlibs). You only need to set this on
304 OS/2 systems and broken/test installations.
305 IOLIBS If set, defines the directory where the libgphoto2_port library
307 looks for its I/O drivers (iolibs). You only need to set this on
308 OS/2 systems and broken/test installations.
309 LD_DEBUG
311 Set this to all to receive lots of debug information regarding
312 library loading on ld based systems.
313 USB_DEBUG
315 If set, defines the numeric debug level with which the libusb
316 library will print messages. In order to get some debug output,
317 set it to 1.
318
320 libgphoto2(3), [1]The gPhoto2 Manual,[2]The gphoto.org website,
321 [3]Digital Camera Support for UNIX, Linux and BSD
322
324 gphoto2 --list-ports
325 Shows what kinds of ports (USB and serial) you have.
326 gphoto2 --auto-detect
328 Shows what camera(s) you have connected.
329 gphoto2 --list-files
331 List files on camera.
332 gphoto2 --get-file 7-13
334 Get files number 7 through 13 from the list output by gphoto2
335 --list-files.
336 To track down errors, you can add the --debug parameter to the gphoto2
338 command line and, if dealing with USB problems, setting the environment
339 variable USB_DEBUG=1.
340
342 The gPhoto2 Team.
343 Tim Waugh <twaugh@redhat.com>Hans Ulrich Niedermann
344 <gp@n-dimensional.de>. (man page)
345
347 1. The gPhoto2 Manual
348 http://www.gphoto.org/doc/manual/
349 2. The gphoto.org website
351 http://www.gphoto.org/
352 3. Digital Camera Support for UNIX, Linux and BSD
354 http://www.teaser.fr/~hfiguiere/linux/digicam.html
355 August 2006 GPHOTO2(1)