forked from gphoto/gphoto2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgphoto2.1
955 lines (954 loc) · 25.7 KB
/
gphoto2.1
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
'\" t
.\" Title: gphoto2
.\" Author: The gPhoto2 Team
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: <pubdate>2015-08-01</pubdate>August 2006
.\" Manual: The gPhoto2 Reference (the man pages)
.\" Source: [FIXME: source]
.\" Language: English
.\"
.TH "GPHOTO2" "1" "<pubdate>2015-08-01</pubdate>August 2006" "[FIXME: source]" "The gPhoto2 Reference (the man"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gphoto2 \- command\-line gphoto2 client
.SH "SYNOPSIS"
.HP \w'\fBgphoto2\fR\ 'u
\fBgphoto2\fR [\-\-debug] [\-\-debug\-logfile\ \fIFILENAME\fR] [\-\-debug\-loglevel\ \fILEVEL\fR] [[\-q] | [\-\-quiet]] [[\-v] | [\-\-verbose]] [[\-h] | [\-\-help]] [\-\-usage]
.br
[\-\-hook\-script\ \fIFILENAME\fR]
.br
[\-\-list\-cameras] [\-\-list\-ports] [\-\-stdout] [\-\-stdout\-size] [\-\-parsable]
.br
[\-\-auto\-detect] [\-\-port\ \fIPATH\fR] [\-\-speed\ \fISPEED\fR] [\-\-camera\ \fIMODEL\fR]
.br
[\-\-filename\ \fIFILENAME\fR] [\-\-filenumber\ \fIFILENUMBER\fR]
.br
[\-\-usbid\ \fIUSBIDS\fR]
.br
[[\-a] | [\-\-abilities]]
.br
[[\-\-folder\ \fIFOLDER\fR] | [\-f\ \fIFOLDER\fR]] [[[\-R] | [\-\-recurse]] | [\-\-no\-recurse]]
.br
[[\-l] | [\-\-list\-folders]]
.br
[[\-L] | [\-\-list\-files]] [[\-m\ \fINAME\fR] | [\-\-mkdir\ \fINAME\fR]]
.br
[[\-r\ \fINAME\fR] | [\-\-rmdir\ \fINAME\fR]] [[\-n] | [\-\-num\-files]]
.br
[[\-p\ \fIRANGE\ or\ NAME\fR] | [\-\-get\-file\ \fIRANGE\ or\ NAME\fR]] [[\-P] | [\-\-get\-all\-files]]
.br
[[\-t\ \fIRANGE\ or\ NAME\fR] | [\-\-get\-thumbnail\ \fIRANGE\ or\ NAME\fR]]
.br
[[\-T] | [\-\-get\-all\-thumbnails]]
.br
[\-\-get\-raw\-data\ \fIRANGE\ or\ NAME\fR] [\-\-get\-all\-raw\-data]
.br
[\-\-get\-audio\-data\ \fIRANGE\ or\ NAME\fR] [\-\-get\-all\-audio\-data]
.br
[\-\-get\-metadata\ \fIRANGE\ or\ NAME\fR] [\-\-get\-all\-metadata] [\-\-upload\-metadata\ \fIFILENAME\fR]
.br
[\-\-force\-overwrite]
.br
[\-\-new]
.br
[[\-d\ \fIRANGE\ or\ NAME\fR] | [\-\-delete\-file\ \fIRANGE\ or\ NAME\fR]] [[\-D] | [\-\-delete\-all\-files]]
.br
[[\-u\ \fIFILENAME\fR] | [\-\-upload\-file\ \fIFILENAME\fR]] [\-\-config]
.br
[\-\-list\-config] [\-\-list\-all\-config]
.br
[\-\-get\-config\ \fICONFIGENTRY\fR] [\-\-set\-config\ \fICONFIGENTRY=CONFIGVALUE\fR] [\-\-set\-config\-index\ \fICONFIGENTRY=CONFIGINDEX\fR] [\-\-set\-config\-value\ \fICONFIGENTRY=CONFIGVALUE\fR] [\-\-reset]
.br
[\-\-capture\-preview] [\-\-show\-preview]
.br
[[\-F\ \fICOUNT\fR] | [\-\-frames\ \fICOUNT\fR]] [[\-I\ \fISECONDS\fR] | [\-\-interval\ \fISECONDS\fR]]
.br
[\-\-reset\-interval]
.br
[\-\-capture\-image] [\-\-trigger\-capture] [\-\-capture\-movie\ \fISECONDS\ or\ COUNT\fR] [\-\-capture\-sound]
.br
[\-\-capture\-tethered\ \fISECONDS,\ COUNT\ or\ STRING\fR]
.br
[\-\-wait\-event\ \fISECONDS,\ COUNT\ or\ STRING\fR] [\-\-wait\-event\-and\-download\ \fISECONDS,\ COUNT\ or\ STRING\fR]
.br
[\-\-keep] [\-\-no\-keep]
.br
[\-\-show\-info\ \fIRANGE\ or\ NAME\fR]
.br
[\-\-show\-exif\ \fIRANGE\ or\ NAME\fR]
.br
[\-\-storage\-info]
.br
[\-\-summary]
.br
[\-\-manual]
.br
[\-\-about]
.br
[\-\-shell]
.SH "DESCRIPTION"
.PP
libgphoto2(3)
is a cross\-platform digital camera library, and
gphoto2(1)
is a command\-line client for it\&.
.PP
Where an option takes a
\fIRANGE\fR
of files, thumbnails, or other data, they are numbered beginning at 1\&. A range is a comma\-separated list of numbers or spans (\(lq\fIfirst\fR\-\fIlast\fR\(rq)\&. Ranges are XOR (exclusive or), so that
\(lq1\-5,3,7\(rq
is equivalent to
\(lq1,2,4,5,7\(rq\&.
.PP
\fB\-\-debug\fR
.RS 4
Turn on debugging output\&. Debugging output is written to stderr by default, or to the filename given to the
\fB\-\-debug\-logfile\fR
option\&.
.RE
.PP
\fB\-\-debug\-logfile\fR \fIFILENAME\fR (since 2\&.3\&.0)
.RS 4
The logfile to write the debugging info to, if
\fB\-\-debug\fR
is given\&.
.RE
.PP
\fB\-\-debug\-loglevel\fR \fILEVEL\fR (since 2\&.5\&.5)
.RS 4
The verbosity of debug logging\&. Possible values with incrementing verbosity are:
\fBerror\fR,
\fBdebug\fR,
\fBdata\fR,
\fBall\fR\&. Default is
\fBall\fR\&.
.RE
.PP
\fB\-\-hook\-script\fR \fIFILENAME\fR (new after 2\&.3\&.0)
.RS 4
Execute the hook script
\fIFILENAME\fR
every time a certain event happens within
\fBgphoto2\fR\&. The hook script reads the environment variable
\fBACTION\fR\&. It must ignore
\fBACTION\fR
values unknown to it\&.
.PP
\fBACTION\fR=init
.RS 4
\fBgphoto2\fR
has just been initialized\&. If the hook script returns with a non\-zero exit code now,
\fBgphoto2\fR
will abort\&.
.RE
.PP
\fBACTION\fR=start
.RS 4
\fBgphoto2\fR
has just finished parsing the command line and is about to start executing the commands given on the command line\&.
.RE
.PP
\fBACTION\fR=download
.RS 4
\fBgphoto2\fR
has just downloaded a file to the computer, storing it in the file indicated by the environment variable
\fBARGUMENT\fR\&.
.RE
.PP
\fBACTION\fR=stop
.RS 4
\fBgphoto2\fR
is about to finish\&. Do your final cleanups here\&.
.RE
.sp
All other environment variables are passed to the hook script unchanged\&. You can make use of that to pass data to the hook script\&.
.sp
Hook script may be specified in the
~/\&.gphoto/settings
file as
\fBgphoto2=hook\-script=\fR\fIfilename\fR\&.
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR
.RS 4
Quiet output (default=verbose)\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Display version and exit\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Display options and short description\&.
.RE
.PP
\fB\-\-usage\fR
.RS 4
Display a short usage message\&.
.RE
.PP
\fB\-\-list\-cameras\fR
.RS 4
List supported camera models\&.
.RE
.PP
\fB\-\-list\-ports\fR
.RS 4
List supported port devices\&.
.RE
.PP
\fB\-\-stdout\fR
.RS 4
Send file to stdout\&.
.RE
.PP
\fB\-\-stdout\-size\fR
.RS 4
Print filesize before data\&.
.RE
.PP
\fB\-\-parsable\fR
.RS 4
Outputs the filelist in a line based format that could be passed into a shellscript or other filter\&.
.RE
.PP
\fB\-\-auto\-detect\fR
.RS 4
List auto\-detected cameras and the ports to which they are connected\&.
.RE
.PP
\fB\-\-port\fR \fIPATH\fR
.RS 4
Specify port device\&. The
\fB\-\-list\-ports\fR
prints a list of valid, usable ports\&. In case of multiple USB cameras, the
\fB\-\-auto\-detect\fR
shows you the specific port each camera is connected to\&.
.RE
.PP
\fB\-\-speed\fR \fISPEED\fR
.RS 4
Specify serial transfer speed\&.
.RE
.PP
\fB\-\-camera\fR \fIMODEL\fR
.RS 4
Specify camera model\&. The
\fB\-\-list\-cameras\fR
option prints a list of all explicitly supported cameras\&.
.sp
Most model names contain spaces: remember to enclose the name in quotes so that the shell knows it is one parameter\&. For example:
\fB\fB\-\-camera\fR\fR\fB "Kodak DC240"\fR\&.
.sp
Note that if you specify
\fB\fB\-\-camera\fR\fR, you must also specify
\fB\fB\-\-port\fR\fR\&. Otherwise the
\fB\fB\-\-camera\fR\fR
option will be silently ignored\&.
.RE
.PP
\fB\-\-filename\fR \fIFILENAME\fR
.RS 4
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\&.
.sp
The
\fB\-\-filename\fR
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, %F for the foldername, %: for the complete filename in lowercase\&.
.sp
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\&.
.sp
%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
\(lq007\(rq)\&. 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\&.
.sp
Default value for this option can be specified in the
~/\&.gphoto/settings
file as
\fBgphoto2=filename=value\fR\&.
.RE
.PP
\fB\-\-filenumber\fR \fIFILENUMBER\fR
.RS 4
If you specify the filename using the
\fB\-\-filename\fR
option and use the %n pattern, this pattern usually starts at 1\&. For incremental usage, you can use
\fB\-\-filenumber\fR
to have it start at another number FILENUMBER\&.
.RE
.PP
\fB\-\-usbid\fR \fI\fIUSBIDS\fR\fR
.RS 4
(Expert only) Override
USB
IDs\&.
\fI \fR\fI\fIUSBIDS\fR\fRmust be of the form
\fI \fR\fI\fIDetectedVendorID\fR\fR\fI:\fR\fI\fIDetectedProductID\fR\fR\fI=\fR\fI\fITreatAsVendorID\fR\fR\fI:\fR\fI\fITreatAsProductID\fR\fR
to treat any USB device detected as
\fI\fIDetectedVendorID\fR\fR\fI:\fR\fI\fIDetectedProductID\fR\fR
as
\fI\fITreatAsVendorID\fR\fR\fI:\fR\fI\fITreatAsProductID\fR\fR
instead\&. All the VendorIDs and ProductIDs should be hexadecimal numbers beginning in C notation, i\&.e\&. beginning with \*(Aq0x\*(Aq\&.
.sp
Example:
\fB\-\-usbid \fR\fB\fI0x4a9:0x306b=0x4a9:0x306c\fR\fR
.RE
.PP
\fB\-a\fR, \fB\-\-abilities\fR
.RS 4
Display the camera and driver abilities specified in the libgphoto2 driver\&. This all does not query the camera, it uses data provided by the library\&. Use
\fB\-\-summary\fR
to query an overview of the camera\&.
.RE
.PP
\fB\-f\fR, \fB\-\-folder\fR \fIFOLDER\fR
.RS 4
Specify camera folder (default="/")\&.
.RE
.PP
\fB\-R\fR, \fB\-\-recurse\fR
.RS 4
Recursion (default for download)\&.
.RE
.PP
\fB\-\-no\-recurse\fR
.RS 4
No recursion (default for deletion)\&.
.RE
.PP
\fB\-l\fR, \fB\-\-list\-folders\fR
.RS 4
List folders in folder\&.
.RE
.PP
\fB\-L\fR, \fB\-\-list\-files\fR
.RS 4
List files in folder\&.
.RE
.PP
\fB\-m\fR, \fB\-\-mkdir\fR \fINAME\fR
.RS 4
Create a directory\&.
.RE
.PP
\fB\-r\fR, \fB\-\-rmdir\fR \fINAME\fR
.RS 4
Remove a directory\&.
.RE
.PP
\fB\-n\fR, \fB\-\-num\-files\fR
.RS 4
Display number of files\&.
.RE
.PP
\fB\-p\fR, \fB\-\-get\-file\fR \fIRANGE\fR
.RS 4
Get files given in range\&.
.RE
.PP
\fB\-P\fR, \fB\-\-get\-all\-files\fR
.RS 4
Get all files from folder\&.
.RE
.PP
\fB\-t\fR, \fB\-\-get\-thumbnail\fR \fIRANGE\fR
.RS 4
Get thumbnails given in range\&.
.RE
.PP
\fB\-T\fR, \fB\-\-get\-all\-thumbnails\fR
.RS 4
Get all thumbnails from folder\&.
.RE
.PP
\fB\-\-get\-raw\-data\fR \fIRANGE\fR
.RS 4
Get raw data given in range\&.
.RE
.PP
\fB\-\-get\-all\-raw\-data\fR
.RS 4
Get all raw data from folder\&.
.RE
.PP
\fB\-\-get\-audio\-data\fR \fIRANGE\fR
.RS 4
Get audio data given in range\&.
.RE
.PP
\fB\-\-get\-all\-audio\-data\fR
.RS 4
Get all audio data from folder\&.
.RE
.PP
\fB\-\-upload\-metadata\fR \fIFILENAME\fR
.RS 4
Upload meta data for the specific file, taken from a file prefix with meta_ \&.
.RE
.PP
\fB\-\-get\-metadata\fR \fIRANGE\fR
.RS 4
Get meta data given in range\&.
.RE
.PP
\fB\-\-get\-all\-metadata\fR
.RS 4
Get all meta data from folder\&.
.RE
.PP
\fB\-\-force\-overwrite\fR
.RS 4
Overwrite files without asking\&.
.RE
.PP
\fB\-\-skip\-existing\fR
.RS 4
Skip files if they exist already on the local directory\&.
.RE
.PP
\fB\-\-new\fR
.RS 4
Only get not already downloaded files\&. This option depends on camera support of flagging already downloaded images and is not available for all drivers\&.
.RE
.PP
\fB\-d\fR, \fB\-\-delete\-file\fR \fIRANGE\fR
.RS 4
Delete files given in range\&.
.RE
.PP
\fB\-D\fR, \fB\-\-delete\-all\-files\fR
.RS 4
Delete all files in folder (defaults to
\fB\-\-no\-recurse\fR)\&.
.RE
.PP
\fB\-u\fR, \fB\-\-upload\-file\fR \fIFILENAME\fR
.RS 4
Upload a file to camera\&.
.RE
.PP
\fB\-\-capture\-preview\fR
.RS 4
Capture a quick preview\&.
.RE
.PP
\fB\-B\fR\fB\-\-bulb\fR \fISECONDS\fR
.RS 4
Do a bulb capture for the specified amount of seconds\&.
.RE
.PP
\fB\-\-show\-preview\fR
.RS 4
Capture a quick preview and displays it in the terminal using Ascii Art (if aalib was used during build)\&.
.RE
.PP
\fB\-F \fR\fB\fICOUNT\fR\fR, \fB\-\-frames \fR\fB\fICOUNT\fR\fR
.RS 4
Number of frames to capture in one run\&. Default is infinite number of frames\&.
.RE
.PP
\fB\-I \fR\fB\fISECONDS\fR\fR, \fB\-\-interval \fR\fB\fISECONDS\fR\fR
.RS 4
Time between capture of multiple frames\&.
.sp
(Since 2\&.4) If
SIGUSR1 signal
is received, a picture is taken immediately without waiting for the end of the current interval period (see
the section called \(lqSIGNALS\(rq)\&. A value of \-1 will let gphoto2 wait forever, i\&.e\&. until a signal arrives\&. See also
\fB\-\-reset\-interval\fR\&.
.RE
.PP
\fB\-\-reset\-interval\fR
.RS 4
Setting this option will reset the time interval to the value given by the
\fB\-I|\-\-interval\fR option
when a
SIGUSR1 signal
is received in time\-lapse mode\&.
.RE
.PP
\fB\-\-capture\-image\fR
.RS 4
Capture an image and keep it on the camera\&.
.RE
.PP
\fB\-\-capture\-image\-and\-download\fR
.RS 4
Capture an image and download it immediately to the computer\&.
.RE
.PP
\fB\-\-trigger\-capture\fR
.RS 4
Triggers the capture an image and return\&. If you want to get the image downloaded, see \-\-wait\-event\-and\-download\&.
.sp
This feature is only available for some camera brands and drivers\&.
.RE
.PP
\fB\-\-keep\fR
.RS 4
When doing \-\-capture\-image\-and\-download or interval capture, this option will keep the images on the memory card of the camera\&.
.RE
.PP
\fB\-\-no\-keep\fR
.RS 4
When doing \-\-capture\-image\-and\-download or interval capture, this option will not keep the images on the memory card of the camera after downloading them during capture\&. (default)
.RE
.PP
\fB\-\-keep\-raw\fR
.RS 4
When doing \-\-capture\-image\-and\-download or interval capture, this option will keep the RAW images on the memory card of the camera, but still download the JPEG images\&. This is useful when doing dual mode capture and you want to review the JPEGs already during capture\&.
.RE
.PP
\fB\-\-capture\-movie \fR\fB\fISECONDS\fR\fR
.RS 4
Capture a movie\&. If the camera supports previews, this will capture a stream of previews (motion\-jpeg) as fast as the camera can\&.
.sp
If not argument is specified, it will capture preview frames until you press Ctrl\-C\&. Arguments that can be specified are either seconds of capture or number of preview frames\&.
.RE
.PP
\fB\-\-capture\-sound\fR
.RS 4
Capture an audio clip\&. No driver supports this at this time\&.
.RE
.PP
\fB\-\-capture\-tethered \fR\fB\fISECONDS, MILLISECONDS, COUNT or MATCHSTRING\fR\fR
.RS 4
Lets gphoto2 wait for notifications from the camera that an object was added\&. This is useful for tethered capture, where pressing the shutter on the camera immediately transfer the image to the machine for processing\&.
.sp
Together with the
\fB\-\-hook\-script\fR
to immediately postprocess or display the images this can help a studio workflow\&.
.sp
This option requires support in the driver and by the camera, currently newer Canon EOS and Nikon DLSR work\&.
.RE
.PP
\fB\-\-wait\-event \fR\fB\fISECONDS, MILLISECONDS, COUNT or MATCHSTRING\fR\fR, \fB\-\-wait\-event\-and\-download \fR\fB\fISECONDS, MILLISECONDS, COUNT or MATCHSTRING\fR\fR
.RS 4
Lets gphoto2 wait for notifications from the camera for various events\&. This is useful for seeing what the camera does and waiting for objects to be added\&. The objects are kept on camera in the
\(lq\-\-wait\-event\(rq
version, with
\(lq\-\-wait\-event\-and\-download\(rq
they are downloaded\&.
.sp
\-\-wait\-event\-and\-download is equivalent to \-\-capture\-tethered\&.
.sp
The time to wait can be either specified as full seconds with a "s" suffix, a number of milliseconds with a "ms" suffix, as a number of events (just a number), or a sub\-string to match\&. If nothing happens, a timeout is generated after 1 second, so a
\(lqwait\-event=5\(rq
will take at most 5 seconds\&. A
\(lq\-\-wait\-event=5s\(rq
will take exactly 5 second\&.
.sp
It is also possible to wait for MATCHSTRING, for things like CAPTURECOMPLETE, FILEADDED, TIMEOUT or other events printed out\&.
.sp
If no argument is given, the wait time is 1 million events (basically forever)\&.
.sp
In the download variant this can be used together with the
\fB\-\-hook\-script\fR
to immediately postprocess or display the images this can help a studio workflow\&.
.sp
This option requires support in the driver and by the camera\&.
.sp
If gphoto2 receives a SIGUSR1 during the wait, it will immediately take a picture (similar to
\(lq\-\-capture\-image\(rq), and depending on mode either leave it on camera or download it\&. (Since 2\&.5\&.28)
.sp
If gphoto2 receives a SIGUSR2 during the wait, it will safely end the tethering\&. (Since 2\&.5\&.25)
.RE
.PP
\fB\-\-show\-info\fR \fIRANGE\fR
.RS 4
Show information for a single or multiple images, like width, height, size and/or the capture time
.RE
.PP
\fB\-\-config\fR
.RS 4
Starts a ncurses based text configuration menu\&. gphoto2 needs to built against CDK for this feature\&.
.RE
.PP
\fB\-\-list\-config\fR
.RS 4
List all configuration entries\&.
.RE
.PP
\fB\-\-list\-all\-config\fR
.RS 4
List all configuration entries and their values and choices\&.
.sp
This command is a combination of
\fB\-\-list\-config\fR
and calling
\fB\-\-get\-config\fR
on all the entries\&.
.RE
.PP
\fB\-\-get\-config\fR \fICONFIGENTRY\fR
.RS 4
Get the specified configuration entry\&.
.sp
This command will list the type, the current value and also the available options of this configuration value\&.
.RE
.PP
\fB\-\-set\-config\fR \fICONFIGENTRY=CONFIGVALUE\fR
.RS 4
Set the specified configuration entry\&. For lists of choices of values this setting first looks up CONFIGVALUE as value and then as index into the choice list\&. Since this is not fully clear, you can use
\fB\-\-set\-config\-index\fR
or
\fB\-\-set\-config\-value\fR
to be more clear what is searched for\&.
.sp
Look at the output of
\fB\-\-get\-config\fR
to see what values are possible to set here\&.
.RE
.PP
\fB\-\-set\-config\-index\fR \fICONFIGENTRY=CONFIGINDEX\fR
.RS 4
Set the specified configuration entry by specifying the index into the list of choices for the configuration value\&. This of course only works for configuration settings that offer list of choices\&.
.sp
Look at the output of
\fB\-\-get\-config\fR
to see what indices are possible to set here\&.
.RE
.PP
\fB\-\-set\-config\-value\fR \fICONFIGENTRY=CONFIGVALUE\fR
.RS 4
Set the specified configuration entry by specifying its new value\&. For lists of choices the value is looked up and set\&.
.sp
Look at the output of
\fB\-\-get\-config\fR
to see what values are possible to set here\&.
.RE
.PP
\fB\-\-reset\fR
.RS 4
Resets the specified (or autodetected) USB port\&.
.sp
This command resets the USB port of either the first auto\-detected camera, or the port specified with
\fB\-\-port usb:XXX,YYY\fR\&. This option is useful if somehow the protocol talking to the camera locked up and simulates plugging out and in the camera\&.
.RE
.PP
\fB\-\-storage\-info\fR
.RS 4
Display information about the camera\*(Aqs storage media\&.
.RE
.PP
\fB\-\-summary\fR
.RS 4
Summary of camera status\&.
.RE
.PP
\fB\-\-manual\fR
.RS 4
Camera driver manual\&.
.RE
.PP
\fB\-\-about\fR
.RS 4
About the camera driver\&.
.RE
.PP
\fB\-\-shell\fR
.RS 4
Start the gphoto2 shell, an interactive environment\&. See
SHELL MODEfor a detailed description\&.
.RE
.SH "SHELL MODE"
.PP
The following commands are available:
.PP
cd \fIDIRECTORY\fR
.RS 4
Change to the specified directory on the camera\&.
.RE
.PP
ls
.RS 4
List the contents of the current directory on the camera\&.
.RE
.PP
lcd \fIDIRECTORY\fR
.RS 4
Change to the specified directory on the local machine\&.
.RE
.PP
get \fIFILENAME\fR
.RS 4
Download the specified file to the current directory\&.
.RE
.PP
put \fIFILENAME\fR
.RS 4
Upload the specified file from the current system directory to the cameras current directory\&.
.RE
.PP
get\-thumbnail \fIFILENAME\fR
.RS 4
Download the specified thumbnail to the current directory\&.
.RE
.PP
get\-raw \fIFILENAME\fR
.RS 4
Download the specified raw data to the current directory\&.
.RE
.PP
show\-info \fIFILENAME\fR
.RS 4
Show information of the specified file\&.
.RE
.PP
delete \fIFILENAME\fR
.RS 4
Delete the specified file or directory\&.
.RE
.PP
mkdir \fIDIRECTORY\fR
.RS 4
Creates a directory named
\(lqDIRECTORY\(rq\&.
.RE
.PP
rmdir \fIDIRECTORY\fR
.RS 4
Removes a directory named
\(lqDIRECTORY\(rq\&.
.RE
.PP
show\-exif \fIFILENAME\fR
.RS 4
Show EXIF information (only if compiled with EXIF support)\&.
.RE
.PP
capture\-image
.RS 4
Captures a single image and keeps it on the camera\&.
.RE
.PP
capture\-image\-and\-download
.RS 4
Captures a single image and downloads it from the camera\&.
.RE
.PP
capture\-preview
.RS 4
Captures a preview image and downloads it from the camera\&.
.RE
.PP
list\-config
.RS 4
Lists all configuration values\&.
.RE
.PP
get\-config \fINAME\fR
.RS 4
Gets the configuration specified by
\(lqNAME\(rq\&.
.RE
.PP
set\-config \fINAME=VALUE\fR
.RS 4
Sets the configuration specified by
\(lqNAME\(rq
to
\(lqVALUE\(rq\&.
.RE
.PP
set\-config\-value \fINAME=VALUE\fR
.RS 4
Sets the configuration specified by
\(lqNAME\(rq
to
\(lqVALUE\(rq\&.
.RE
.PP
set\-config\-index \fINAME=VALUE\fR
.RS 4
Sets the configuration specified by
\(lqNAME\(rq
to the
\(lqINDEX\(rq
into the list of choices\&. Works only for Menu or Radio button entries\&.
.RE
.PP
wait\-event \fICOUNT or SECONDS\fR
.RS 4
Waits for events from the camera for the specified time in SECONDS (if suffixed with s) or the COUNT of events from the camera, where every seconds a timeout event happens\&. Newly added images are kept on the camera\&.
.sp
Default is 1 event\&.
.RE
.PP
wait\-event\-and\-download \fICOUNT or SECONDS\fR, capture\-tethered \fICOUNT or SECONDS\fR
.RS 4
Waits for events from the camera for the specified time in SECONDS (if suffixed with s) or the COUNT of events from the camera, where every seconds a timeout event happens\&. Newly added images are downloaded from the camera\&.
.sp
Default is 1 event\&.
.RE
.PP
help, ?
.RS 4
Displays command usage\&.
.RE
.PP
exit, quit, q
.RS 4
Exit the gphoto2 shell\&.
.RE
.SH "ENVIRONMENT VARIABLES"
.PP
\fBCAMLIBS\fR
.RS 4
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\&.
.RE
.PP
\fBIOLIBS\fR
.RS 4
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\&.
.RE
.PP
\fBLD_DEBUG\fR
.RS 4
Set this to
\fIall\fR
to receive lots of debug information regarding library loading on
\fBld\fR
based systems\&.
.RE
.PP
\fBUSB_DEBUG\fR
.RS 4
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
\fI1\fR\&.
.RE
.SH "SIGNALS"
.PP
SIGUSR1 (since 2\&.4)
.RS 4
In time\-lapse capture and in tethering or wait\-event mode, receiving a SIGUSR1 signal makes gphoto2 take a picture immediately\&.
.sp
If the
\fB\-\-reset\-interval\fR option
is given, the time counter is reset to the value given by the
\fB\-I|\-\-interval\fR option\&. Note that the camera will need some time (from 50ms to a few seconds) to actually capture the image\&.
.RE
.PP
SIGUSR2 (since 2\&.5\&.26)
.RS 4
In tethering or wait\-event mode, receiving a SIGUSR2 signal ends the tethering or wait\-event mode\&. This is useful if you do not know the end before hand, but still want to safely exit the waiting\&.
.RE
.SH "SEE ALSO"
.PP
libgphoto2(3),
\m[blue]\fBThe gPhoto2 Manual\fR\m[]\&\s-2\u[1]\d\s+2,
\m[blue]\fBThe gphoto\&.org website\fR\m[]\&\s-2\u[2]\d\s+2,
\m[blue]\fBDigital Camera Support for UNIX, Linux and BSD\fR\m[]\&\s-2\u[3]\d\s+2
.SH "EXAMPLES"
.PP
\fBgphoto2 \fR\fB\fB\-\-list\-ports\fR\fR
.RS 4
Shows what kinds of ports (USB
and serial) you have\&.
.RE
.PP
\fBgphoto2 \fR\fB\fB\-\-auto\-detect\fR\fR
.RS 4
Shows what camera(s) you have connected\&.
.RE
.PP
\fBgphoto2 \fR\fB\fB\-\-list\-files\fR\fR
.RS 4
List files on camera\&.
.RE
.PP
\fBgphoto2 \fR\fB\fB\-\-get\-file\fR\fR\fB \fR\fB\fI7\-13\fR\fR
.RS 4
Get files number 7 through 13 from the list output by
\fB\fBgphoto2\fR\fR\fB \fR\fB\fB\-\-list\-files\fR\fR\&.
.RE
.PP
\fBgphoto2 \fR\fB\fB\-\-capture\-image\fR\fR\fB \fR\fB\fB\-\-interval\fR\fR\fB \fR\fB\fI60\fR\fR\fB \fR\fB\fB\-\-hook\-script\fR\fR\fB \fR\fB\fI/usr/share/doc/gphoto2/test\-hook\&.sh\fR\fR
.RS 4
Capture one image every 60 seconds from now to eternity\&. The example hook script will be called after each captured image has been stored on the computer\&.
.RE
.PP
To track down errors, you can add the
\fB\-\-debug\fR
parameter to the
\fBgphoto2\fR
command line and, if dealing with USB problems, setting the environment variable
\fBUSB_DEBUG\fR\fI=1\fR\&.
.SH "AUTHORS"
.PP
\fBTim Waugh\fR
.RS 4
Author.
.RE
.PP
\fBHans Ulrich Niedermann, current maintainer\fR <\&[email protected]\&>
.RS 4
Author.
.RE
.PP
\fBMichael J. Rensing\fR
.RS 4
Author.
.RE
.PP
\fBMarcus Meissner\fR <\&[email protected]\&>
.RS 4
Author.
.RE
.PP
\fBMiscellanous Contributors.\fR
.PP
\fBThe gPhoto2 Team\fR
.RS 4
Author.
.RE
.PP
\fBTim Waugh\fR <\&twaugh@redhat\&.com\&>
.RS 4
Original man page author\&.
.RE
.PP
\fBHans Ulrich Niedermann\fR <\&gp@n\-dimensional\&.de\&>
.RS 4
Current man page editor\&.
.RE
.SH "NOTES"
.IP " 1." 4
The gPhoto2 Manual
.RS 4
\%http://www.gphoto.org/doc/manual/
.RE
.IP " 2." 4
The gphoto.org website
.RS 4
\%http://www.gphoto.org/
.RE
.IP " 3." 4
Digital Camera Support for UNIX, Linux and BSD
.RS 4
\%http://www.teaser.fr/~hfiguiere/linux/digicam.html
.RE