File: gpscorrelate-manpage.xml.in

package info (click to toggle)
gpscorrelate 1.6.1-7
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 936 kB
  • sloc: ansic: 1,781; cpp: 440; makefile: 61
file content (414 lines) | stat: -rw-r--r-- 12,243 bytes parent folder | download
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
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

  <!ENTITY dhfirstname "<firstname>Stefano</firstname>">
  <!ENTITY dhsurname   "<surname>Zacchiroli</surname>">
  <!ENTITY dhdate      "<date>30 Oct 2008</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>zack@debian.org</email>">
  <!ENTITY dhusername  "Stefano Zacchiroli">
  <!ENTITY dhucpackage "<refentrytitle>GPSCORRELATE</refentrytitle>">
  <!ENTITY dhpackage   "gpscorrelate">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;, Till Maas
    </author>
    <copyright>
      <year>2006, 2008</year>
      <holder>&dhusername; &dhemail;, Till Maas</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>correlates digital images with GPS data filling EXIF fields</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <group>
        <arg choice="plain">-z</arg>
        <arg choice="plain">
          --timeadd +/-<replaceable>HH</replaceable>[:<replaceable>MM</replaceable>]
        </arg>
      </group>
      
      <group>
        <arg choice="plain">-O</arg>
        <arg choice="plain">
          --photooffset <replaceable>seconds</replaceable>
        </arg>
      </group>
      
      <group>
        <arg choice="plain">-i</arg>
        <arg choice="plain">--no-interpolation</arg>
      </group>

      <group>
        <arg choice="plain">-v</arg>
        <arg choice="plain">--verbose</arg>
      </group>

      <group>
        <arg choice="plain">-d</arg>
        <arg choice="plain">--datum <replaceable>datum</replaceable>
        </arg>
      </group>
      
      <group>
        <arg choice="plain">-n</arg>
        <arg choice="plain">--no-write</arg>
      </group>
      
      <group>
        <arg choice="plain">-F</arg>
        <arg choice="plain">--force</arg>
      </group>

      <group>
        <arg choice="plain">-m</arg>
        <arg choice="plain">--max-dist <replaceable>time</replaceable>
        </arg>
      </group>

      <group>
        <arg choice="plain">-t</arg>
        <arg choice="plain">--ignore-tracksegs</arg>
      </group>

      <group>
        <arg choice="plain">-M</arg>
        <arg choice="plain">--no-mtime</arg>
      </group>
      
      <group>
        <arg choice="plain">-f</arg>
        <arg choice="plain">--fix-timestamps</arg>
      </group>
      
      <group>
        <arg choice="plain">-p</arg>
        <arg choice="plain">--degmins</arg>
      </group>

      
      <arg choice="plain">
        -g <replaceable>file.gpx</replaceable>
      </arg>
      <arg rep="repeat" choice="plain">
        <replaceable>image.jpg</replaceable>
      </arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>&dhpackage;</command>
      <group choice="plain">
        <arg choice="plain">-s</arg>
        <arg choice="plain">--show</arg>
        <arg choice="plain">-o</arg>
        <arg choice="plain">--machine</arg>
      </group>
      <arg rep="repeat" choice="plain"><replaceable>image.jpg</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>&dhpackage;</command>
      <group> 
        <arg choice="plain">-M</arg>
        <arg choice="plain">--no-mtime</arg>
      </group>

      <group choice="req">
        <arg choice="plain">-r</arg>
        <arg choice="plain">--remove</arg>
      </group>
      <arg rep="repeat" choice="plain"><replaceable>image.jpg</replaceable></arg>
    </cmdsynopsis>
    
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <group choice="plain">
        <arg choice="plain">-V</arg>
        <arg choice="plain">--version</arg>
        <arg choice="plain">-h</arg>
        <arg choice="plain">--help</arg>
      </group>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>&dhpackage;-gui</command>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the <command>&dhpackage;</command>
      and <command>&dhpackage;-gui</command> commands.</para>

    <para>There is an extended documentation available in HTML format; see below.</para>

    <para><command>&dhpackage;</command> is a program that acts on digital images
      in JPEG format filling EXIF (Exchangeable Image File Format) fields
      related to GPS (Global Positioning System) information.  Source for the
      GPS data is a record of GPS information encoded in GPX (GPS Exchange
      Format) Format. The act of filling those fields is referred to as
      <emphasis>correlation</emphasis>.</para>

    <para> If GPS data are available at the precise moment the image was taken
      (with a 1-second granularity) the GPS data are stored unmodified in EXIF
      fields. If they are not linear interpolation of GPS data available at
      moments before and after the image was taken can be used. </para>

    <para><command>&dhpackage;</command> is a command line tool implementing
      correlation whereas <command>&dhpackage;-gui</command> is the
      corresponding GTK+ graphical user interface. </para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax, with long
      options starting with two dashes (`-').  A summary of options is included
      below.  For a complete description, see the HTML documentation. </para>

    <variablelist>
      <varlistentry>
        <term>
          <option>-g</option>,
          <option>--gps</option>
          <replaceable>file.gpx</replaceable>
        </term>
        <listitem>
          <para>correlate using the specified GPX file with GPS data</para>
        </listitem>
    </varlistentry>

      <varlistentry>
        <term>
          <option>-s</option>,
          <option>--show</option>
        </term>
        <listitem>
          <para>only show the GPS data of the given images</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-o</option>,
          <option>--machine</option>
        </term>
        <listitem>
          <para>only show the GPS data of the given images in a machine
            readable output, if there is any</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-r</option>,
          <option>--remove</option>
        </term>
        <listitem>
          <para>only remove GPS EXIF data from the given images</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-z</option>,
          <option>--timeadd</option>
          <userinput>+/-</userinput><replaceable>XX</replaceable>[<userinput>:</userinput><replaceable>XX</replaceable>]
        </term>
        <listitem>
          <para>time to add to GPS data to make it match the timestamps of the
            images. GPS data is in UTC; images are not likely to be in UTC.
            Enter the timezone used when taking the images: eg,
            <userinput>+8</userinput> for Perth </para>
        </listitem>
      </varlistentry>
      
      <varlistentry>
        <term>
          <option>-O</option>,
          <option>--photooffset</option>
          <replaceable>seconds</replaceable>
        </term>
        <listitem>
          <para>time in seconds to add to the photo timestamp to make it match
            the GPS timestamp.  To determine the amount of seconds needed, just
            create a picture of your GPS device showing the current time and
            compare it with the timestamp of your photo file. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-i</option>,
          <option>--no-interpolation</option>
        </term>
        <listitem>
          <para>disable interpolation between points.  Interpolation is linear,
            points are rounded if disabled </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-v</option>,
          <option>--verbose</option>
        </term>
        <listitem>
          <para>show which GPS data has been selected for each image</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-d</option>,
          <option>--datum</option> <replaceable>datum</replaceable>
        </term>
        <listitem>
          <para>specify measurement datum. If not set, WGS-84 used</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-n</option>,
          <option>--no-write</option>
        </term>
        <listitem>
          <para>do not write the exif data. Useful with
            <userinput>--verbose</userinput></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-F</option>,
          <option>--force</option>
        </term>
        <listitem>
          <para>overwrite existing GPS tags</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-m</option>,
          <option>--max-dist</option> <replaceable>time</replaceable>
        </term>
        <listitem>
          <para>max time outside points that image will be matched. Time is in
            seconds </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-t</option>,
          <option>--ignore-tracksegs</option>
        </term>
        <listitem>
          <para>Interpolate between track segments, too</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-M</option>,
          <option>--no-mtime</option>
        </term>
        <listitem>
          <para>Do not change mtime of modified files</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-f</option>,
          <option>--fix-timestamps</option>
        </term>
        <listitem>
          <para>Fix broken GPS datestamps written with versions &lt; 1.5.2</para>
        </listitem>
      </varlistentry>
      
      <varlistentry>
        <term>
          <option>-p</option>,
          <option>--degmins</option>
        </term>
        <listitem>
          <para>Write location as DD MM.MM as was default before &lt; 1.5.3</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-h</option>,
          <option>--help</option>
        </term>
        <listitem>
          <para>Only show summary of options</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-V</option>,
          <option>--version</option>
        </term>
        <listitem>
          <para>Only print the version</para>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>gpsd (1), gpsbabel (1), gpxlogger (1), cgpxlogger (1).</para>

    <para>The documentation of &dhpackage; and &dhpackage;-gui in HTML format
      are available on the filesystem at <filename
        class="directory">@DOCDIR@</filename>.
    </para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was initially written by &dhusername; &dhemail; for
      the &debian; system.  It was extended by Till Maas
      <email>opensource@till.name</email>. Permission is granted to copy,
      distribute and/or modify this document under the terms of the &gnu;
      General Public License, Version 2 any later version published by the Free
      Software Foundation.  </para>

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

  </refsect1>
</refentry>