summaryrefslogtreecommitdiff
path: root/doc/rapid-photo-downloader.1.pod
blob: f9fdd0cf79e8fe8ea6dfaa572da8b350cbb64663 (plain)
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
=head1 NAME

rapid-photo-downloader - Downloads, renames and backs up photos and videos from cameras, phones,
memory cards and other devices

=head1 SYNOPSIS

B<rapid-photo-downloader> [options] [path]

Options:

    -h, --help
    --version
    --detailed-version
    -v, --verbose
    --debug
    -e, --extensions
    --photo-renaming {on,off}
    --video-renaming {on,off}
    -a {on,off}, --auto-detect {on,off}
    -t {on,off}, --this-computer {on,off}
    --this-computer PATH
    --photo-destination PATH
    --video-destination PATH
    -b {on,off}, --backup {on,off}
    --backup-auto-detect {on,off}
    --photo-backup-identifier FOLDER
    --video-backup-identifier FOLDER
    --photo-backup-location PATH
    --video-backup-location PATH
    --ignore-other-photo-file-types
    --auto-download-startup {on,off}
    --auto-download-device-insertion {on,off}
    --thumbnail-cache {on,off}
    --delete-thumbnail-cache
    --forget-remembered-files
    --import-old-version-preferences
    --reset
    --log-gphoto2
    --camera-info


=head1 DESCRIPTION

B<Rapid Photo Downloader> imports photos and videos from cameras, phones,
memory cards and other devices at high speed. It can be configured to
rename photos and videos with meaningful filenames you specify. It can also
back up photos and videos as they are downloaded. It downloads from and backs
up to multiple devices simultaneously.

Unique to Rapid Photo Downloader is its Timeline, which groups photos and
videos based on how much time elapsed between consecutive shots. Use it to
identify photos and videos taken at different periods in a single day or
over consecutive days.

Files are downloaded from two different types of sources: (1) one or more
automatically detected devices like cameras, phones, memory cards, and external
drives; and (2) a single manually specified path, shown in the user interface as
"This Computer".

=head1 PATH

Optional value that when specified, is parsed to determine if it represents an
automatically detected device or a path on this computer.

If the path represents an automatically detected device, automatic detection of
devices is turned on, as in the B<--auto-detect> option. Furthermore, downloading from a manually
specified path as in the B<--this-computer-location> option is turned off.

Otherwise, the path is assumed to be a manually specified path as in the
B<--this-computer-location> option, in which case downloading from this computer is turned on
and downloading from automatically detected devices is turned off.

=head1 OPTIONS

=over

=item B<-h, --help>

Show help message and exit.

=item B<--version>

Displays information about the currently installed version and exits.

=item B<--detailed-version>

Displays information about the currently installed version and its libraries and exits.

=item B<-v, --verbose>

Displays program information on the command line as the program runs.

=item B<--debug>

Displays debugging information on the command line as the program runs

=item B<-e, --extensions>

Displays image file extensions the program recognizes and exits.

=item B<--photo-renaming {on,off}>

Turn on or off the the renaming of photos while downloading,
overwriting existing program preferences. If turned on,
the renaming scheme used will incorporate the photo's metadata date, time,
the number of downloads today, and the file extension in lower case:
S<C<YYYYMMDD-HHMM-E<lt>DownloadsTodayE<gt>.E<lt>LowercaseExtensionE<gt>>>,
e.g. 20160512-1309-23.jpg.

=item B<--video-renaming {on,off}>

Turn on or off the the renaming of videos while downloading,
overwriting existing program preferences. If turned on,
the renaming scheme used will incorporate the video's metadata date, time,
the number of downloads today, and the file extension in lower case:
S<C<YYYYMMDD-HHMM-E<lt>DownloadsTodayE<gt>.E<lt>LowercaseExtensionE<gt>>>,
e.g. 20160512-1429-26.mp4.

=item B<-a {on,off}, --auto-detect {on,off}>

Turn on or off the automatic detection of devices from which to download, 
overwriting existing program preferences.

=item B<-t {on,off}, --this-computer {on,off}>

Turn on or off downloading from this computer (see description above),
overwriting existing program preferences.

=item B<--this-computer-location PATH>

The PATH on this computer from which to download, overwriting existing program 
preferences.

=item B<--photo-destination PATH>

Sets the PATH where photos will be downloaded to, overwriting existing program
preferences.

=item B<--video-destination PATH>

Sets the PATH where videos will be downloaded to, overwriting existing program
preferences.

=item B<-b {on,off}, --backup {on,off}>

Turns on or off the backing up of photos and videos while downloading, overwriting
existing program preferences.

=item B<--backup-auto-detect {on,off}>

Turns on or off the automatic detection of backup devices, overwriting
existing program preferences.

=item B<--photo-backup-identifier FOLDER>

Sets the FOLDER in which backups are stored on the automatically detected photo backup 
device, with the folder's name being used to identify whether or not the device
is used for backups. For each device you wish to use for backing up photos to, 
create a folder on it with this name. Overwrites existing program preferences.

=item B<--video-backup-identifier FOLDER>

Sets the FOLDER in which backups are stored on the automatically detected video backup 
device, with the folder's name being used to identify whether or not the device
is used for backups. For each device you wish to use for backing up videos to, 
create a folder on it with this name. Overwrites existing program preferences.

=item B<--photo-backup-location PATH>

Sets the PATH where photos will be backed up when automatic detection of backup devices
is turned off. Overwrites existing program preferences.

=item B<--video-backup-location PATH>

Sets the PATH where videos will be backed up when automatic detection of backup devices
is turned off. Overwrites existing program preferences.

=item B<--ignore-other-photo-file-types>

Do not download photos with the following extensions: TIF, TIFF and MPO.

=item B<--auto-download-startup {on,off}>

Turns on or off starting downloads as soon as the program itself starts.

=item B<--auto-download-device-insertion {on,off}>

Turns on or off starting downloads as soon as a device is inserted.

=item B<--thumbnail-cache {on,off}>

Turns on or off use of the Rapid Photo Downloader Thumbnail Cache. Turning it off does not
delete existing cache contents.

=item B<--delete-thumbnail-cache>

Deletes all thumbnails in the Rapid Photo Downloader Thumbnail Cache, and exits.

=item B<--forget-remembered-files>

Forgets which files have been previously downloaded, and exits.

=item B<--import-old-version-preferences>

Imports preferences from an old program version (S<0.4.11> or earlier), and exits. Requires the
command line program S<gconftool-2>.

=item B<--reset>

Resets all program settings to their default values, deletes all thumbnails in the Thumbnail
cache, forgets which files have been previously downloaded, and exits.

=item B<--log-gphoto2>

Includes gphoto2 debugging information in log files, which can be useful when analyzing
any problems libgphoto2 might have accessing a camera.

=item B<--camera-info>

Print information to the terminal about attached cameras and exit.

=back

=head1 ENVIRONMENT

If the environment variable RPD_SCAN_DEBUG is set to any value, the program's scan
operation will output volumous debug information to stdout.


=head1 SEE ALSO

analyze-pv-structure(1)

=head1 AUTHORS

B<Rapid Photo Downloader> was written by Damon Lynch <damonlynch@gmail.com>.

This manual page was written by Damon Lynch.

=head1 COPYRIGHT

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3, or (at your option) any
later version.

On Debian GNU/Linux systems, the complete text of the GNU General
Public License can be found in `/usr/share/common-licenses/GPL'.

=cut