| blob | 2db09f6d72e6c9c16ec8484a3a8b20281db9fdd0 |
1 .\" Title: gpst
2 .\" Author:
3 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
4 .\" Date: $Id$
5 .\" Manual:
6 .\" Source:
7 .\"
8 .TH "GPST" "1" "$Id$" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 gpst \- Converts between various GPS formats.
15 .SH "SYNOPSIS"
16 .HP 5
17 \fBgpst\fR [\fIoptions\fR] [\fIfile\fR...]
18 .HP 5
19 \fBgpst\fR {\-S} [\fIoptions\fR] [\fIfile\fR...]
20 .HP 5
21 \fBgpst\fR {\-u} [\fIoptions\fR] [\fIfile\fR...]
22 .SH "DESCRIPTION"
23 .PP
24 \fB\-\-chronology\fR
25 .RS 4
26 Check for broken chronology, warn about entries with an old timestamp.
27 .RE
28 .PP
29 \fB\-d\fR, \fB\-\-skip\-dups\fR
30 .RS 4
31 If succeeding identical coordinates are found, print only the first one and ignore the rest.
32 .RE
33 .PP
34 \fB\-e\fR, \fB\-\-epoch\fR
35 .RS 4
36 Use seconds since 1970\-01\-01 00:00:00 GMT as date format.
37 .RE
38 .PP
39 \fB\-\-fix\fR
40 .RS 4
41 Comment out entries which is obviously wrong. Use together with
42 \fB\-\-chronology\fR
43 to fix those kind of errors. Does not work with GPX output yet.
44 .RE
45 .PP
46 \fB\-\-from\-date \fR\fB\fIx\fR\fR
47 .RS 4
48 Used by the
49 pgwupd
50 format. Specifies from which date waypoints should be updated. No checks for valid date format here, let
51 PostgreSQL
52 take care of that. All variants it understands can be used here.
53 .RE
54 .PP
55 \fB\-h\fR, \fB\-\-help\fR
56 .RS 4
57 Send a brief help summary to stdout.
58 .RE
59 .PP
60 \fB\-\-inside\fR
61 .RS 4
62 Print only trackpoints inside a rectangle specified by
63 \fB\-\-pos1\fR
64 and
65 \fB\-\-pos2\fR.
66 .RE
67 .PP
68 \fB\-n\fR, \fB\-\-undefined \fR\fB\fIx\fR\fR
69 .RS 4
70 Use
71 \fIx\fR
72 as undefined value.
73 .RE
74 .PP
75 \fB\-\-near\fR
76 .RS 4
77 Add names of the three closest waypoints to the trackpoint. Unfinished and experimental, needs
78 \fBgpsbabel\fR(1), which is called from the program as
79 \fB/usr/local/bin/gpsbabel\fR.
80 .RE
81 .PP
82 \fB\-o\fR, \fB\-\-output\-format \fR\fB\fIx\fR\fR
83 .RS 4
84 Use output format
85 \fIx\fR:
86 .RS 4
87 .PP
88 \fBclean\fR
89 .RS 4
90 TAB\-separated format with longitude, latitude and altitude.
91 .RE
92 .PP
93 \fBcsv\fR
94 .RS 4
95 TAB\-separated format:
96 .RS 4
97 .PP
98 date
99 .RS 4
100 Date of trackpoint. Format:
101 \fIyyyy\fR\-\fImm\fR\-\fIdd\fRT\fIhh\fR:\fImm\fR:\fIss\fRZ
102 unless the
103 \fB\-\-epoch\fR
104 option is specified. If so, it\(cqs represented as number of seconds since 1970\-01\-01 00:00:00 UTC.
105 .RE
106 .PP
107 longitude
108 .RS 4
109 Longitude, decimal degrees.
110 .RE
111 .PP
112 latitude
113 .RS 4
114 Latitude, decimal degrees.
115 .RE
116 .PP
117 altitude
118 .RS 4
119 Altitude in metres above sea level. Optional. If not present, the corresponding TAB is also printed, to keep the number of columns intact.
120 .RE
121 .RE
122 .RE
123 .PP
124 \fBgpsml\fR (Default)
125 .RS 4
126 Line\-based XML which makes it easy to edit and grep. In the past, there was this big plan about making this the default storage format, so it was declared as The Honourable Default Output Format. But using GPX is the way to go, so this will probably change in the future. It\(cqs way too
127 de facto
128 and widely used, so storing GPS data in anything else is sheer waste of work. Probably not finished yet.
129 .RE
130 .PP
131 \fBgpstrans\fR
132 .RS 4
133 The format generated by
134 \fBgpstrans\fR(1).
135 .RE
136 .PP
137 \fBgpx\fR
138 .RS 4
139 Not complete yet, but good enough in most cases.
140 .RE
141 .PP
142 \fBpgtab\fR
143 .RS 4
144 TAB\-separated format for import into
145 PostgreSQL. Undefined values are written as
146 \\N
147 if the
148 \fB\-\-undefined\fR
149 option is not specified.
150 .RS 4
151 .PP
152 date
153 .RS 4
154 Format:
155 \fIyyyy\fR\-\fImm\fR\-\fIdd\fRT\fIhh\fR:\fImm\fR:\fIss\fRZ
156 .RE
157 .PP
158 coor
159 .RS 4
160 Format:
161 (\fIlat\fR,\fIlon\fR)
162 .RE
163 .PP
164 ele
165 .RS 4
166 Altitude in metres above sea level.
167 .RE
168 .PP
169 sted
170 .RS 4
171 Short name of closest waypoint. Calculated in
172 PostgreSQL, so this value is always
173 \\N.
174 .RE
175 .PP
176 dist
177 .RS 4
178 Distance in decimal degrees to closest waypoint. Calculated in
179 PostgreSQL, so this value is always
180 \\N.
181 .RE
182 .PP
183 description
184 .RS 4
185 Description of waypoint. Calculated in
186 PostgreSQL, so this value is always
187 \\N.
188 .RE
189 .PP
190 avst
191 .RS 4
192 Distance to trackpoint in decimal degrees from a defined
193 \(lqhome\(rq
194 position. This is calculated in
195 PostgreSQL, so the field value is always
196 \\N.
197 .RE
198 .RE
199 .RE
200 .PP
201 \fBpgwtab\fR
202 .RS 4
203 Output waypoints on a TAB\-separated format:
204 .RS 4
205 .PP
206 coor
207 .RS 4
208 Format:
209 (\fIlat\fR,\fIlon\fR)
210 .RE
211 .PP
212 name
213 .RS 4
214 Title of waypoint.
215 .RE
216 .PP
217 ele
218 .RS 4
219 Elevation in metres above sea level.
220 .RE
221 .PP
222 type
223 .RS 4
224 Type of waypoint, same as the GPX
225 <type>
226 element.
227 .RE
228 .PP
229 time
230 .RS 4
231 Timestamp of waypoint.
232 .RE
233 .PP
234 cmt
235 .RS 4
236 Short waypoint description, used by the GPS as a comment. Same as the GPX
237 <cmt>
238 element.
239 .RE
240 .PP
241 descr
242 .RS 4
243 Long description, not used by the GPS. Same as the GPX
244 <desc>
245 element.
246 .RE
247 .PP
248 src
249 .RS 4
250 Source of data, same as the
251 <src>
252 GPX element.
253 .RE
254 .PP
255 sym
256 .RS 4
257 GPS symbol name. Same as the
258 <sym>
259 GPX element.
260 .RE
261 .RE
262 .RE
263 .PP
264 \fBpgwupd\fR
265 .RS 4
266 Output waypoints as SQL transactions which updates the
267 sted
268 and
269 dist
270 columns.
271 .RE
272 .PP
273 \fBposcount\fR
274 .RS 4
275 Creates a 3D plot where areas with many trackpoints are higher than areas with less track points.
276 .RE
277 .PP
278 \fBps\fR
279 .RS 4
280 Postscript. Unfinished.
281 .RE
282 .PP
283 \fBsvg\fR
284 .RS 4
285 Unfinished.
286 .RE
287 .PP
288 \fBxgraph\fR
289 .RS 4
290 Input format for
291 \fBxgraph\fR(1).
292 .RE
293 .PP
294 \fBygraph\fR
295 .RS 4
296 Input format for
297 \fBygraph\fR(1).
298 .RE
299 .RE
300 .RE
301 .PP
302 \fB\-\-outside\fR
303 .RS 4
304 Print only trackpoints outside a rectangle specified by
305 \fB\-\-pos1\fR
306 and
307 \fB\-\-pos2\fR.
308 .RE
309 .PP
310 \fB\-\-pos1 \fR\fB\fIx1\fR\fR\fB,\fR\fB\fIy1\fR\fR, \fB\-\-pos2 \fR\fB\fIx2\fR\fR\fB,\fR\fB\fIy2\fR\fR
311 .RS 4
312 Specifies corners of an area rectangle used by the
313 \fB\-\-inside\fR
314 and
315 \fB\-\-outside\fR
316 options. The
317 \fIx\fR
318 and
319 \fIy\fR
320 values are specified as decimal degrees, negative for west or south.
321 .RE
322 .PP
323 \fB\-r\fR, \fB\-\-require \fR\fB\fIx\fR\fR
324 .RS 4
325 Specify requirements for trackpoints to be written.
326 \fIx\fR
327 is a string with the following flags:
328 .RS 4
329 .PP
330 \fBe\fR
331 .RS 4
332 Print only waypoints which have an elevation.
333 .RE
334 .PP
335 \fBp\fR
336 .RS 4
337 Print only waypoints which have a position.
338 .RE
339 .PP
340 \fBt\fR
341 .RS 4
342 Print only waypoints which have a timestamp.
343 .RE
344 .RE
345 .RE
346 .PP
347 \fB\-R\fR, \fB\-\-round \fR\fB\fIx\fR\fR\fB=\fR\fB\fIy\fR\fR\fB[,\fIx2\fR=\fIy2\fR[...]]\fR
348 .RS 4
349 Round trackpoint element
350 \fIx\fR
351 to
352 \fIy\fR
353 decimals.
354 .sp
355 Example:
356 \fB\-\-round lat=4,lon=5,ele=1\fR
357 .RE
358 .PP
359 \fB\-s\fR, \fB\-\-short\-date\fR
360 .RS 4
361 Use short date format.
362 .RE
363 .PP
364 \fB\-S\fR, \fB\-\-save\-to\-file \fR\fB\fIx\fR\fR
365 .RS 4
366 Save the unconverted data to a file with a filename starting with the timestamp of the first trackpoint. The parameter string
367 \fIx\fR
368 is added at the end of the filename. For the time being this option will ignore all other options.
369 .sp
370 .it 1 an-trap
371 .nr an-no-space-flag 1
372 .nr an-break-flag 1
373 .br
374 \fBNote\fR
375 If several files are specified on the command line, all data will be saved into only one file. This behaviour may change in the future.
376 .RE
377 .PP
378 \fB\-t\fR, \fB\-\-create\-breaks\fR
379 .RS 4
380 Create breaks in track between points with a difference more than the number of seconds specified by the
381 \fBPAUSE_LIMIT\fR
382 variable.
383 .RE
384 .PP
385 \fB\-u\fR, \fB\-\-comment\-out\-dups\fR
386 .RS 4
387 Comment out following data with identical position values, only print first entry.
388 .RE
389 .PP
390 \fB\-v\fR, \fB\-\-verbose\fR
391 .RS 4
392 Verbose output, can be repeated.
393 .RE
394 .PP
395 \fB\-\-version\fR
396 .RS 4
397 Print program version information.
398 .RE
399 .PP
400 \fB\-w\fR, \fB\-\-strip\-whitespace\fR
401 .RS 4
402 Strip all unnecessary whitespace.
403 .RE
404 .PP
405 \fB\-y\fR, \fB\-\-double\-y\-scale\fR
406 .RS 4
407 Double Y scale (latitude).
408 .RE
409 .PP
410 \fB\-\-debug\fR
411 .RS 4
412 Print debugging messages.
413 .RE
414 .SH "BUGS AND THINGS THAT NEED TO BE DONE"
415 .TP 4
416 \(bu
417 Pretty incomplete in some areas. Some of the source formats are undocumented and thus incomplete. Some functionality is not working properly, for example the Postscript output.
418 .TP 4
419 \(bu
420 Remove hardcodings, for example the
421 \(lqhome\(rq
422 position used to calculate the
423 avst
424 database column.
425 .TP 4
426 \(bu
427 Translate database column names to English.
428 .TP 4
429 \(bu
430 Add more tests to cover all command\-line options.
431 .SH "AUTHOR"
432 .PP
433 Made by
434 Øyvind A. Holm
435 <sunny@sunbase.org>.
436 .SH "COPYRIGHT"
437 .PP
438 Copyleft \(co
439 Øyvind A. Holm
440 <sunny@sunbase.org>. This is free software; see the file
441 \fICOPYING\fR
442 for legalese stuff.
443 .SH "LICENSE"
444 .PP
445 This program is free software; you can redistribute it and/or modify it under the terms of the
446 GNU General Public License
447 as published by the
448 Free Software Foundation; either version 2 of the License, or (at your option) any later version.
449 .PP
450 This program is distributed in the hope that it will be useful, but
451 \fIWITHOUT ANY WARRANTY\fR; without even the implied warranty of
452 \fIMERCHANTABILITY\fR
453 or
454 \fIFITNESS FOR A PARTICULAR PURPOSE\fR. See the GNU General Public License for more details.
455 .PP
456 You should have received a copy of the GNU General Public License along with this program; if not, write to
457 .sp
458 .RS 4
459 .nf
460 The Free Software Foundation, Inc.
461 59 Temple Place, Suite 330
462 Boston, MA 02111\-1307
463 USA
464 .fi
465 .RE
466 .SH "SEE ALSO"
467 .PP
468 \fBgpsbabel\fR(1)