1GPHOTO2(1) The gPhoto2 Reference (the man GPHOTO2(1)
2
6 gphoto2 - command-line gphoto2 client
7
9 gphoto2 [--debug] [--debug-logfile FILENAME] [--debug-loglevel LEVEL]
10 [[-q] | [--quiet]] [[-v] | [--verbose]] [[-h] | [--help]]
11 [--usage]
12 [--hook-script FILENAME]
13 [--list-cameras] [--list-ports] [--stdout] [--stdout-size]
14 [--auto-detect] [--port PATH] [--speed SPEED] [--camera MODEL]
15 [--filename FILENAME]
16 [--usbid USBIDS]
17 [[-a] | [--abilities]]
18 [[--folder FOLDER] | [-f FOLDER]] [[[-R] | [--recurse]] |
19 [--no-recurse]]
20 [[-l] | [--list-folders]]
21 [[-L] | [--list-files]] [[-m NAME] | [--mkdir NAME]]
22 [[-r NAME] | [--rmdir NAME]] [[-n] | [--num-files]]
23 [[-p RANGE or NAME] | [--get-file RANGE or NAME]] [[-P] |
24 [--get-all-files]]
25 [[-t RANGE or NAME] | [--get-thumbnail RANGE or NAME]]
26 [[-T] | [--get-all-thumbnails]]
27 [--get-raw-data RANGE or NAME] [--get-all-raw-data]
28 [--get-audio-data RANGE or NAME] [--get-all-audio-data]
29 [--get-metadata RANGE or NAME] [--get-all-metadata]
30 [--upload-metadata FILENAME]
31 [--force-overwrite]
32 [--new]
33 [[-d RANGE or NAME] | [--delete-file RANGE or NAME]] [[-D] |
34 [--delete-all-files]]
35 [[-u FILENAME] | [--upload-file FILENAME]] [--config]
36 [--list-config] [--list-all-config]
37 [--get-config CONFIGENTRY]
38 [--set-config CONFIGENTRY=CONFIGVALUE]
39 [--set-config-index CONFIGENTRY=CONFIGINDEX]
40 [--set-config-value CONFIGENTRY=CONFIGVALUE] [--reset]
41 [--capture-preview] [--show-preview]
42 [[-F COUNT] | [--frames COUNT]] [[-I SECONDS] |
43 [--interval SECONDS]]
44 [--reset-interval]
45 [--capture-image] [--trigger-capture]
46 [--capture-movie SECONDS or COUNT] [--capture-sound]
47 [--capture-tethered SECONDS, COUNT or STRING]
48 [--wait-event SECONDS, COUNT or STRING]
49 [--wait-event-and-download SECONDS, COUNT or STRING]
50 [--keep] [--no-keep]
51 [--show-info RANGE or NAME]
52 [--show-exif RANGE or NAME]
53 [--storage-info]
54 [--summary]
55 [--manual]
56 [--about]
57 [--shell]
58
60 libgphoto2(3) is a cross-platform digital camera library, and
61 gphoto2(1) is a command-line client for it.
62 Where an option takes a RANGE of files, thumbnails, or other data, they
64 are numbered beginning at 1. A range is a comma-separated list of
65 numbers or spans (“first-last”). Ranges are XOR (exclusive or), so that
66 “1-5,3,7” is equivalent to “1,2,4,5,7”.
67 --debug
69 Turn on debugging output. Debugging output is written to stderr by
70 default, or to the filename given to the --debug-logfile option.
71 --debug-logfile FILENAME (since 2.3.0)
73 The logfile to write the debugging info to, if --debug is given.
74 --debug-loglevel LEVEL (since 2.5.5)
76 The verbosity of debug logging. Possible values with incrementing
77 verbosity are: error, debug, data, all. Default is all.
78 --hook-script FILENAME (new after 2.3.0)
80 Execute the hook script FILENAME every time a certain event happens
81 within gphoto2. The hook script reads the environment variable
82 ACTION. It must ignore ACTION values unknown to it.
83 ACTION=init
85 gphoto2 has just been initialized. If the hook script returns
86 with a non-zero exit code now, gphoto2 will abort.
87 ACTION=start
89 gphoto2 has just finished parsing the command line and is about
90 to start executing the commands given on the command line.
91 ACTION=download
93 gphoto2 has just downloaded a file to the computer, storing it
94 in the file indicated by the environment variable ARGUMENT.
95 ACTION=stop
97 gphoto2 is about to finish. Do your final cleanups here.
98 All other environment variables are passed to the hook script
100 unchanged. You can make use of that to pass data to the hook
101 script.
102 Hook script may be specified in the ~/.gphoto/settings file as
104 gphoto2=hook-script=filename.
105 -q, --quiet
107 Quiet output (default=verbose).
108 -v, --version
110 Display version and exit.
111 -h, --help
113 Display options and short description.
114 --usage
116 Display a short usage message.
117 --list-cameras
119 List supported camera models.
120 --list-ports
122 List supported port devices.
123 --stdout
125 Send file to stdout.
126 --stdout-size
128 Print filesize before data.
129 --auto-detect
131 List auto-detected cameras and the ports to which they are
132 connected.
133 --port PATH
135 Specify port device. The --list-ports prints a list of valid,
136 usable ports. In case of multiple USB cameras, the --auto-detect
137 shows you the specific port each camera is connected to.
138 --speed SPEED
140 Specify serial transfer speed.
141 --camera MODEL
143 Specify camera model. The --list-cameras option prints a list of
144 all explicitly supported cameras.
145 Most model names contain spaces: remember to enclose the name in
147 quotes so that the shell knows it is one parameter. For example:
148 --camera "Kodak DC240".
149 Note that if you specify --camera, you must also specify --port.
151 Otherwise the --camera option will be silently ignored.
152 --filename FILENAME
154 When downloading files from the camera, specify the file name or
155 file name pattern to use when storing the downloaded file on the
156 local disk. When uploading a file to the camera, specify the
157 filename to store the uploaded file as on the camera.
158 The --filename option accepts %a, %A, %b, %B, %d, %H, %k, %I, %l,
160 %j, %m, %M, %S, %y, %%, (see date(1)) and, in addition, %n for the
161 number, %C for the filename suffix, %f for the filename without
162 suffix, %F for the foldername, %: for the complete filename in
163 lowercase.
164 Note that %: is still in alpha stage, and the actual character or
166 syntax may still be changed. E.g. it might be possible to use %#f
167 and %#C for lower case versions, and %^f and %^C for upper case
168 versions.
169 %n is the only conversion specifier to accept a padding character
171 and width: %03n will pad with zeros to width 3 (e.g. print the
172 number 7 as “007”). Leaving out the padding character (e.g. %3n)
173 will use an implementation specific default padding character which
174 may or may not be suitable for use in file names.
175 Default value for this option can be specified in the
177 ~/.gphoto/settings file as gphoto2=filename=value.
178 --usbid USBIDS
180 (Expert only) Override USB IDs.
181 USBIDSmust be of the form
182 DetectedVendorID:DetectedProductID=TreatAsVendorID:TreatAsProductID
183 to treat any USB device detected as
184 DetectedVendorID:DetectedProductID as
185 TreatAsVendorID:TreatAsProductID instead. All the VendorIDs and
186 ProductIDs should be hexadecimal numbers beginning in C notation,
187 i.e. beginning with '0x'.
188 Example: --usbid 0x4a9:0x306b=0x4a9:0x306c
190 -a, --abilities
192 Display the camera and driver abilities specified in the libgphoto2
193 driver. This all does not query the camera, it uses data provided
194 by the library. Use --summary to query an overview of the camera.
195 -f, --folder FOLDER
197 Specify camera folder (default="/").
198 -R, --recurse
200 Recursion (default for download).
201 --no-recurse
203 No recursion (default for deletion).
204 -l, --list-folders
206 List folders in folder.
207 -L, --list-files
209 List files in folder.
210 -m, --mkdir NAME
212 Create a directory.
213 -r, --rmdir NAME
215 Remove a directory.
216 -n, --num-files
218 Display number of files.
219 -p, --get-file RANGE
221 Get files given in range.
222 -P, --get-all-files
224 Get all files from folder.
225 -t, --get-thumbnail RANGE
227 Get thumbnails given in range.
228 -T, --get-all-thumbnails
230 Get all thumbnails from folder.
231 --get-raw-data RANGE
233 Get raw data given in range.
234 --get-all-raw-data
236 Get all raw data from folder.
237 --get-audio-data RANGE
239 Get audio data given in range.
240 --get-all-audio-data
242 Get all audio data from folder.
243 --upload-metadata FILENAME
245 Upload meta data for the specific file, taken from a file prefix
246 with meta_ .
247 --get-metadata RANGE
249 Get meta data given in range.
250 --get-all-metadata
252 Get all meta data from folder.
253 --force-overwrite
255 Overwrite files without asking.
256 --skip-existing
258 Skip files if they exist already on the local directory.
259 --new
261 Only get not already downloaded files. This option depends on
262 camera support of flagging already downloaded images and is not
263 available for all drivers.
264 -d, --delete-file RANGE
266 Delete files given in range.
267 -D, --delete-all-files
269 Delete all files in folder (defaults to --no-recurse).
270 -u, --upload-file FILENAME
272 Upload a file to camera.
273 --capture-preview
275 Capture a quick preview.
276 -B--bulb SECONDS
278 Do a bulb capture for the specified amount of seconds.
279 --show-preview
281 Capture a quick preview and displays it in the terminal using Ascii
282 Art (if aalib was used during build).
283 -F COUNT, --frames COUNT
285 Number of frames to capture in one run. Default is infinite number
286 of frames.
287 -I SECONDS, --interval SECONDS
289 Time between capture of multiple frames.
290 (Since 2.4) If SIGUSR1 signal is received, a picture is taken
292 immediately without waiting for the end of the current interval
293 period (see the section called “SIGNALS”). A value of -1 will let
294 gphoto2 wait forever, i.e. until a signal arrives. See also
295 --reset-interval.
296 --reset-interval
298 Setting this option will reset the time interval to the value given
299 by the -I|--interval option when a SIGUSR1 signal is received in
300 time-lapse mode.
301 --capture-image
303 Capture an image and keep it on the camera.
304 --capture-image-and-download
306 Capture an image and download it immediately to the computer.
307 --trigger-capture
309 Triggers the capture an image and return. If you want to get the
310 image downloaded, see --wait-event-and-download.
311 This feature is only available for some camera brands and drivers.
313 --keep
315 When doing --capture-image-and-download or interval capture, this
316 option will keep the images on the memory card of the camera.
317 --no-keep
319 When doing --capture-image-and-download or interval capture, this
320 option will not keep the images on the memory card of the camera
321 after downloading them during capture. (default)
322 --keep-raw
324 When doing --capture-image-and-download or interval capture, this
325 option will keep the RAW images on the memory card of the camera,
326 but still download the JPEG images. This is useful when doing dual
327 mode capture and you want to review the JPEGs already during
328 capture.
329 --capture-movie SECONDS
331 Capture a movie. If the camera supports previews, this will capture
332 a stream of previews (motion-jpeg) as fast as the camera can.
333 If not argument is specified, it will capture preview frames until
335 you press Ctrl-C. Arguments that can be specified are either
336 seconds of capture or number of preview frames.
337 --capture-sound
339 Capture an audio clip. No driver supports this at this time.
340 --capture-tethered SECONDS, MILLISECONDS, COUNT or MATCHSTRING
342 Lets gphoto2 wait for notifications from the camera that an object
343 was added. This is useful for tethered capture, where pressing the
344 shutter on the camera immediately transfer the image to the machine
345 for processing.
346 Together with the --hook-script to immediately postprocess or
348 display the images this can help a studio workflow.
349 This option requires support in the driver and by the camera,
351 currently newer Canon EOS and Nikon DLSR work.
352 --wait-event SECONDS, MILLISECONDS, COUNT or MATCHSTRING,
354 --wait-event-and-download SECONDS, MILLISECONDS, COUNT or MATCHSTRING
355 Lets gphoto2 wait for notifications from the camera for various
356 events. This is useful for seeing what the camera does and waiting
357 for objects to be added. The objects are kept on camera in the
358 “--wait-event” version, with “--wait-event-and-download” they are
359 downloaded.
360 --wait-event-and-download is equivalent to --capture-tethered.
362 The time to wait can be either specified as full seconds with a "s"
364 suffix, a number of milliseconds with a "ms" suffix, as a number of
365 events (just a number), or a sub-string to match. If nothing
366 happens, a timeout is generated after 1 second, so a “wait-event=5”
367 will take at most 5 seconds. A “--wait-event=5s” will take exactly
368 5 second.
369 If no argument is given, the wait time is 1 million events
371 (basically forever).
372 In the download variant this can be used together with the
374 --hook-script to immediately postprocess or display the images this
375 can help a studio workflow.
376 This option requires support in the driver and by the camera,
378 currently newer Canon EOS and Nikon DSC are known to work.
379 --show-info RANGE
381 Show information for a single or multiple images, like width,
382 height, size and/or the capture time
383 --config
385 Starts a ncurses based text configuration menu. gphoto2 needs to
386 built against CDK for this feature.
387 --list-config
389 List all configuration entries.
390 --list-all-config
392 List all configuration entries and their values and choices.
393 This command is a combination of --list-config and calling
395 --get-config on all the entries.
396 --get-config CONFIGENTRY
398 Get the specified configuration entry.
399 This command will list the type, the current value and also the
401 available options of this configuration value.
402 --set-config CONFIGENTRY=CONFIGVALUE
404 Set the specified configuration entry. For lists of choices of
405 values this setting first looks up CONFIGVALUE as value and then as
406 index into the choice list. Since this is not fully clear, you can
407 use --set-config-index or --set-config-value to be more clear what
408 is searched for.
409 Look at the output of --get-config to see what values are possible
411 to set here.
412 --set-config-index CONFIGENTRY=CONFIGINDEX
414 Set the specified configuration entry by specifying the index into
415 the list of choices for the configuration value. This of course
416 only works for configuration settings that offer list of choices.
417 Look at the output of --get-config to see what indices are possible
419 to set here.
420 --set-config-value CONFIGENTRY=CONFIGVALUE
422 Set the specified configuration entry by specifying its new value.
423 For lists of choices the value is looked up and set.
424 Look at the output of --get-config to see what values are possible
426 to set here.
427 --reset
429 Resets the specified (or autodetected) USB port.
430 This command resets the USB port of either the first auto-detected
432 camera, or the port specified with --port usb:XXX,YYY. This option
433 is useful if somehow the protocol talking to the camera locked up
434 and simulates plugging out and in the camera.
435 --storage-info
437 Display information about the camera's storage media.
438 --summary
440 Summary of camera status.
441 --manual
443 Camera driver manual.
444 --about
446 About the camera driver.
447 --shell
449 Start the gphoto2 shell, an interactive environment. See SHELL
450 MODEfor a detailed description.
451
453 The following commands are available:
454 cd DIRECTORY
456 Change to the specified directory on the camera.
457 ls
459 List the contents of the current directory on the camera.
460 lcd DIRECTORY
462 Change to the specified directory on the local machine.
463 get FILENAME
465 Download the specified file to the current directory.
466 put FILENAME
468 Upload the specified file from the current system directory to the
469 cameras current directory.
470 get-thumbnail FILENAME
472 Download the specified thumbnail to the current directory.
473 get-raw FILENAME
475 Download the specified raw data to the current directory.
476 show-info FILENAME
478 Show information of the specified file.
479 delete FILENAME
481 Delete the specified file or directory.
482 mkdir DIRECTORY
484 Creates a directory named “DIRECTORY”.
485 rmdir DIRECTORY
487 Removes a directory named “DIRECTORY”.
488 show-exif FILENAME
490 Show EXIF information (only if compiled with EXIF support).
491 capture-image
493 Captures a single image and keeps it on the camera.
494 capture-image-and-download
496 Captures a single image and downloads it from the camera.
497 capture-preview
499 Captures a preview image and downloads it from the camera.
500 list-config
502 Lists all configuration values.
503 get-config NAME
505 Gets the configuration specified by “NAME”.
506 set-config NAME=VALUE
508 Sets the configuration specified by “NAME” to “VALUE”.
509 set-config-value NAME=VALUE
511 Sets the configuration specified by “NAME” to “VALUE”.
512 set-config-index NAME=VALUE
514 Sets the configuration specified by “NAME” to the “INDEX” into the
515 list of choices. Works only for Menu or Radio button entries.
516 wait-event COUNT or SECONDS
518 Waits for events from the camera for the specified time in SECONDS
519 (if suffixed with s) or the COUNT of events from the camera, where
520 every seconds a timeout event happens. Newly added images are kept
521 on the camera.
522 Default is 1 event.
524 wait-event-and-download COUNT or SECONDS, capture-tethered COUNT or
526 SECONDS
527 Waits for events from the camera for the specified time in SECONDS
528 (if suffixed with s) or the COUNT of events from the camera, where
529 every seconds a timeout event happens. Newly added images are
530 downloaded from the camera.
531 Default is 1 event.
533 help, ?
535 Displays command usage.
536 exit, quit, q
538 Exit the gphoto2 shell.
539
541 CAMLIBS
542 If set, defines the directory where the libgphoto2 library looks
543 for its camera drivers (camlibs). You only need to set this on OS/2
544 systems and broken/test installations.
545 IOLIBS
547 If set, defines the directory where the libgphoto2_port library
548 looks for its I/O drivers (iolibs). You only need to set this on
549 OS/2 systems and broken/test installations.
550 LD_DEBUG
552 Set this to all to receive lots of debug information regarding
553 library loading on ld based systems.
554 USB_DEBUG
556 If set, defines the numeric debug level with which the libusb
557 library will print messages. In order to get some debug output, set
558 it to 1.
559
561 SIGUSR1 (since 2.4)
562 In time-lapse capture mode, receiving a SIGUSR1 signal makes
563 gphoto2 take a picture immediately.
564 If the --reset-interval option is given, the time counter is reset
566 to the value given by the -I|--interval option. Note that the
567 camera will need some time (from 50ms to a few seconds) to actually
568 capture the image.
569
571 libgphoto2(3), The gPhoto2 Manual[1],
572 The gphoto.org website[2], Digital Camera Support for UNIX, Linux and
574 BSD[3]
575
577 gphoto2 --list-ports
578 Shows what kinds of ports (USB and serial) you have.
579 gphoto2 --auto-detect
581 Shows what camera(s) you have connected.
582 gphoto2 --list-files
584 List files on camera.
585 gphoto2 --get-file 7-13
587 Get files number 7 through 13 from the list output by gphoto2
588 --list-files.
589 gphoto2 --capture-image --interval 60 --hook-script
591 /usr/share/doc/gphoto2/test-hook.sh
592 Capture one image every 60 seconds from now to eternity. The
593 example hook script will be called after each captured image has
594 been stored on the computer.
595 To track down errors, you can add the --debug parameter to the gphoto2
597 command line and, if dealing with USB problems, setting the environment
598 variable USB_DEBUG=1.
599
601 Tim Waugh
602 Author.
603 Hans Ulrich Niedermann, current maintainer <gp@n-dimensional.de>
605 Author.
606 Michael J. Rensing
608 Author.
609 Marcus Meissner <marcus@jet.franken.de>
611 Author.
612 Miscellanous Contributors.
614 The gPhoto2 Team
616 Author.
617 Tim Waugh <twaugh@redhat.com>
619 Original man page author.
620 Hans Ulrich Niedermann <gp@n-dimensional.de>
622 Current man page editor.
623
625 1. The gPhoto2 Manual
626 http://www.gphoto.org/doc/manual/
627 2. The gphoto.org website
629 http://www.gphoto.org/
630 3. Digital Camera Support for UNIX, Linux and BSD
632 http://www.teaser.fr/~hfiguiere/linux/digicam.html
633[FIXME: source] <pubdate>2015-08-01</pubdate>August 2006 GPHOTO2(1)