From Linux Man Pages
gphoto2 - command-line gphoto2 client
SYNOPSIS
gphoto2 [--debug] [--debug-logfile FILENAME] [[-q] [--quiet]] [[-v] [--verbose]] [[-h] [--help]]
[--list-cameras] [--list-ports] [--stdout] [--stdout-size]
[--auto-detect] [--port PATH] [--speed SPEED] [--camera MODEL]
[--filename FILENAME]
[--usbid USBIDS]
[[-a] [--abilities]]
[[--folder FOLDER] [-f FOLDER]] [[[-R] [--recurse]] [--no-recurse]] [[-l] [--list-folders]]
[[-L] [--list-files]] [[-m NAME] [--mkdir NAME]]
[[-r NAME] [--rmdir NAME]] [[-n] [--num-files]]
[[-p RANGE] [--get-file RANGE]] [[-P] [--get-all-files]]
[[-t RANGE] [--get-thumbnail RANGE]]
[[-T] [--get-all-thumbnails]]
[--get-raw-data RANGE] [--get-all-raw-data]
[--get-audio-data RANGE] [--get-all-audio-data]
[--force-overwrite]
[--new]
[[-d RANGE] [--delete-file RANGE]] [[-D] [--delete-all-files]]
[[-u FILENAME] [--upload-file FILENAME]] [--config]
[--list-config]
[--get-config CONFIGENTRY]
[--set-config CONFIGENTRY=CONFIGVALUE]
[--capture-preview]
[[-F COUNT] [--frames COUNT]] [[-I SECONDS] [--interval SECONDS]] [--capture-image] [--capture-movie]
[--capture-sound]
[--show-info RANGE]
[--show-exif RANGE]
[--summary] [--manual] [--about] [--shell]
DESCRIPTION
libgphoto2(3) is a cross-platform digital camera library, and gphoto2(1) is a command-line client for it.
Where an option takes a RANGE of files, thumbnails, or other data, they are numbered beginning at 1. A range is a
comma-separated list of numbers or spans ("first-last"). Ranges are XOR (exclusive or), so that "1-5,3,7" is
equivalent to "1,2,4,5,7".
--debug
Turn on debugging output. Debugging output is written to stderr by default, or to the filename given to
the --debug-logfile option.
--debug-logfile FILENAME (new in version 2.2.x SVN trunk)
The logfile to write the debugging info to, if --debug is given.
-q, --quiet
Quiet output (default=verbose).
-v, --version
Display version and exit.
-h, --help
Display a short usage message.
--list-cameras
List supported camera models.
--list-ports
List supported port devices.
--stdout
Send file to stdout.
--stdout-size
Print filesize before data.
--auto-detect
List auto-detected cameras and the ports to which they are connected.
--port PATH
Specify port device. The --list-ports prints a list of valid, usable ports. In case of multiple USB
cameras, the --auto-detect shows you the specific port each camera is connected to.
--speed SPEED
Specify serial transfer speed.
--camera MODEL
Specify camera model. The --list-cameras option prints a list of all explicitly supported cameras.
Most model names contain spaces: remember to enclose the name in quotes so that the shell knows it is one
parameter. For example: --camera "Kodak DC240".
Note that if you specify --camera, you must also specify --port. Otherwise the --camera option will be
silently ignored.
--filename FILENAME
When downloading files from the camera, specify the file name or file name pattern to use when storing the
downloaded file on the local disk. When uploading a file to the camera, specify the filename to store the
uploaded file as on the camera.
The --filename option accepts %a, %A, %b, %B, %d, %H, %k, %I, %l, %j, %m, %M, %S, %y, %%, (see date(1))
and, in addition, %n for the number, %C for the filename suffix, %f for the filename without suffix, %:
for the complete filename in lowercase.
Note that %: is still in alpha stage, and the actual character or syntax may still be changed. E.g. it
might be possible to use %#f and %#C for lower case versions, and %^f and %^C for upper case versions.
%n is the only conversion specifier to accept a padding character and width: %03n will pad with zeros to
width 3 (e.g. print the number 7 as "007"). Leaving out the padding character (e.g. %3n) will use an
implementation specific default padding character which may or may not be suitable for use in file names.
--usbid USBIDS
(Expert only) Override USB IDs.
USBIDSmust be of the form
DetectedVendorID:DetectedProductID=TreatAsVendorID:TreatAsProductID to treat any USB device detected as
DetectedVendorID:DetectedProductID as TreatAsVendorID:TreatAsProductID instead. All the VendorIDs and
ProductIDs should be hexadecimal numbers beginning in C notation, i.e. beginning with '0x'.
Example: --usbid 0x4a9:0x306b=0x4a9:0x306c
-a, --abilities
Display camera abilities.
-f, --folder FOLDER
Specify camera folder (default="/").
-R, --recurse
Recursion (default for download).
--no-recurse
No recursion (default for deletion).
-l, --list-folders
List folders in folder.
-L, --list-files
List files in folder.
-m, --mkdir NAME
Create a directory.
-r, --rmdir NAME
Remove a directory.
-n, --num-files
Display number of files.
-p, --get-file RANGE
Get files given in range.
-P, --get-all-files
Get all files from folder.
-t, --get-thumbnail RANGE
Get thumbnails given in range.
-T, --get-all-thumbnails
Get all thumbnails from folder.
--get-raw-data RANGE
Get raw data given in range.
--get-all-raw-data
Get all raw data from folder.
--get-audio-data RANGE
Get audio data given in range.
--get-all-audio-data
Get all audio data from folder.
--force-overwrite
Overwrite files without asking.
--new Only get not already downloaded files. This option depends on camera support of flagging already
downloaded images and is not available for all drivers.
-d, --delete-file RANGE
Delete files given in range.
-D, --delete-all-files
Delete all files in folder.
-u, --upload-file FILENAME
Upload a file to camera.
--capture-preview
Capture a quick preview.
-F COUNT, --frames COUNT
Number of frames to capture in one run. Default is infinite number of frames.
-I SECONDS, --interval SECONDS
Time between capture of multiple frames.
--capture-image
Capture an image.
--capture-movie
Capture a movie.
--capture-sound
Capture an audio clip.
--show-info RANGE
Show info.
--list-config
List all configuration entries.
--get-config CONFIGENTRY
Get the specified configuration entry.
--set-config CONFIGENTRY=CONFIGVALUE
Set the specified configuration entry.
--summary
Summary of camera status.
--manual
Camera driver manual.
--about
About the camera driver.
--shell
Start the gphoto2 shell, an interactive environment. See SHELL MODEfor a detailed description.
SHELL MODE
The following commands are available:
cd Change to a directory on the camera.
ls List the contents of the current directory on the camera.
lcd Change to a directory on the local machine.
get Download the file to the current directory.
get-thumbnail
Download the thumbnail to the current directory.
get-raw
Download raw data to the current directory.
show-info
Show information.
delete Delete a file or directory.
show-exif
Show EXIF information (only if compiled with EXIF support).
help, ?
Displays command usage.
exit, quit, q
Exit the gphoto2 shell.
ENVIRONMENT VARIABLES
CAMLIBS
If set, defines the directory where the libgphoto2 library looks for its camera drivers (camlibs). You
only need to set this on OS/2 systems and broken/test installations.
IOLIBS If set, defines the directory where the libgphoto2_port library looks for its I/O drivers (iolibs). You
only need to set this on OS/2 systems and broken/test installations.
LD_DEBUG
Set this to all to receive lots of debug information regarding library loading on ld based systems.
USB_DEBUG
If set, defines the numeric debug level with which the libusb library will print messages. In order to get
some debug output, set it to 1.
RELATED
libgphoto2(3), [1]The gPhoto2 Manual,[2]The gphoto.org website, [3]Digital Camera Support for UNIX, Linux and BSD
EXAMPLES
gphoto2 --list-ports
Shows what kinds of ports (USB and serial) you have.
gphoto2 --auto-detect
Shows what camera(s) you have connected.
gphoto2 --list-files
List files on camera.
gphoto2 --get-file 7-13
Get files number 7 through 13 from the list output by gphoto2 --list-files.
To track down errors, you can add the --debug parameter to the gphoto2 command line and, if dealing with USB
problems, setting the environment variable USB_DEBUG=1.
REFERENCES
1. The gPhoto2 Manual
http://www.gphoto.org/doc/manual/
2. The gphoto.org website
http://www.gphoto.org/
3. Digital Camera Support for UNIX, Linux and BSD
http://www.teaser.fr/~hfiguiere/linux/digicam.html
CATEGORY