Remove branches/gpst-breakfix/, it has its own branch now.
[gpstools.git] / branches / gpst.xml-option / doc / gpst.1
blob8d5d091ac472297ae571f5517d41b2be24cef412
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. If the
27 \fB\-\-xml\fR
28 option is specified, the result of the scan is written to stdout as usual, and all other output is suppressed. If the
29 \fB\-\-xml\fR
30 option is
31 \fInot\fR
32 used, it is reported as warnings to stderr.
33 .RE
34 .PP
35 \fB\-d\fR, \fB\-\-skip\-dups\fR
36 .RS 4
37 If succeeding identical coordinates are found, print only the first one and ignore the rest.
38 .RE
39 .PP
40 \fB\-e\fR, \fB\-\-epoch\fR
41 .RS 4
42 Use seconds since 1970\-01\-01 00:00:00 GMT as date format.
43 .RE
44 .PP
45 \fB\-\-fix\fR
46 .RS 4
47 Comment out entries which is obviously wrong. Use together with
48 \fB\-\-chronology\fR
49 to fix those kind of errors. Does not work with GPX output yet.
50 .RE
51 .PP
52 \fB\-h\fR, \fB\-\-help\fR
53 .RS 4
54 Send a brief help summary to stdout.
55 .RE
56 .PP
57 \fB\-\-inside\fR
58 .RS 4
59 Print only trackpoints inside a rectangle specified by
60 \fB\-\-pos1\fR
61 and
62 \fB\-\-pos2\fR.
63 .RE
64 .PP
65 \fB\-\-near\fR
66 .RS 4
67 Add names of the three closest waypoints to the trackpoint. Unfinished and experimental, needs
68 \fBgpsbabel\fR(1).
69 .RE
70 .PP
71 \fB\-n\fR, \fB\-\-undefined \fR\fB\fIx\fR\fR
72 .RS 4
73 Use
74 \fIx\fR
75 as undefined value.
76 .RE
77 .PP
78 \fB\-o\fR, \fB\-\-output\-format \fR\fB\fIx\fR\fR
79 .RS 4
80 Use output format
81 \fIx\fR:
82 .RS 4
83 .PP
84 \fBclean\fR
85 .RS 4
86 TAB\-separated format with longitude, latitude and altitude.
87 .RE
88 .PP
89 \fBcsv\fR
90 .RS 4
91 TAB\-separated format:
92 .RS 4
93 .PP
94 date
95 .RS 4
96 Date of trackpoint. Format:
97 \fIyyyy\fR\-\fImm\fR\-\fIdd\fRT\fIhh\fR:\fImm\fR:\fIss\fRZ
98 unless the
99 \fB\-\-epoch\fR
100 option is specified. If so, it\(cqs represented as number of seconds since 1970\-01\-01 00:00:00 UTC.
103 longitude
104 .RS 4
105 Longitude, decimal degrees.
108 latitude
109 .RS 4
110 Latitude, decimal degrees.
113 altitude
114 .RS 4
115 Altitude in metres above sea level. Optional. If not present, the corresponding TAB is also printed, to keep the number of columns intact.
120 \fBgpsml\fR (Default)
121 .RS 4
122 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
123 de facto
124 and widely used, so storing GPS data in anything else is sheer waste of work. Probably not finished yet.
127 \fBgpstrans\fR
128 .RS 4
129 The format generated by
130 \fBgpstrans\fR(1).
133 \fBgpx\fR
134 .RS 4
135 Not complete yet, but good enough in most cases.
138 \fBposcount\fR
139 .RS 4
140 Creates a 3D plot where areas with many trackpoints are higher than areas with less track points.
143 \fBps\fR
144 .RS 4
145 Postscript. Unfinished.
148 \fBsvg\fR
149 .RS 4
150 Unfinished.
153 \fBxgraph\fR
154 .RS 4
155 Input format for
156 \fBxgraph\fR(1).
159 \fBygraph\fR
160 .RS 4
161 Input format for
162 \fBygraph\fR(1).
167 \fB\-\-outside\fR
168 .RS 4
169 Print only trackpoints outside a rectangle specified by
170 \fB\-\-pos1\fR
172 \fB\-\-pos2\fR.
175 \fB\-\-pos1 \fR\fB\fIx\fR\fR, \fB\-\-pos2 \fR\fB\fIx\fR\fR
176 .RS 4
177 Specifies corners of an area rectangle used by the
178 \fB\-\-inside\fR
180 \fB\-\-outside\fR
181 options. The
182 \fIx\fR
183 value is in
184 \fIlat\fR,\fIlon\fR
185 format (decimal degrees, negative for west or south).
188 \fB\-r\fR, \fB\-\-require \fR\fB\fIx\fR\fR
189 .RS 4
190 Specify requirements for trackpoints to be written.
191 \fIx\fR
192 is a string with the following flags:
193 .RS 4
195 \fBe\fR
196 .RS 4
197 Print only waypoints which have an elevation.
200 \fBp\fR
201 .RS 4
202 Print only waypoints which have a position.
205 \fBt\fR
206 .RS 4
207 Print only waypoints which have a timestamp.
212 \fB\-R\fR, \fB\-\-round \fR\fB\fIx\fR\fR\fB=\fR\fB\fIy\fR\fR\fB[,\fIx2\fR=\fIy2\fR[...]]\fR
213 .RS 4
214 Round trackpoint element
215 \fIx\fR
217 \fIy\fR
218 decimals.
220 Example:
221 \fB\-\-round lat=4,lon=5,ele=1\fR
224 \fB\-s\fR, \fB\-\-short\-date\fR
225 .RS 4
226 Use short date format.
229 \fB\-S\fR, \fB\-\-save\-to\-file \fR\fB\fIx\fR\fR
230 .RS 4
231 Save the unconverted data to a file with a filename starting with the timestamp of the first trackpoint. The parameter string
232 \fIx\fR
233 is added at the end of the filename. For the time being this option will ignore all other options.
235 .it 1 an-trap
236 .nr an-no-space-flag 1
237 .nr an-break-flag 1
239 \fBNote\fR
240 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.
243 \fB\-t\fR, \fB\-\-create\-breaks\fR
244 .RS 4
245 Create breaks in track between points with a difference more than the number of seconds specified by the
246 \fI$PAUSE_LIMIT\fR
247 variable.
250 \fB\-u\fR, \fB\-\-comment\-out\-dups\fR
251 .RS 4
252 Comment out following data with identical position values, only print first entry.
255 \fB\-v\fR, \fB\-\-verbose\fR
256 .RS 4
257 Verbose output, can be repeated.
260 \fB\-w\fR, \fB\-\-strip\-whitespace\fR
261 .RS 4
262 Strip all unnecessary whitespace.
265 \fB\-x\fR, \fB\-\-xml\fR
266 .RS 4
267 Create XML output.
271 \fB\-y\fR, \fB\-\-double\-y\-scale\fR
272 .RS 4
273 Double Y scale (latitude) to get it right in gnuplot.
276 \fB\-\-version\fR
277 .RS 4
278 Print version information.
281 \fB\-\-debug\fR
282 .RS 4
283 Print debugging messages.
285 .SH "BUGS"
287 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.
288 .SH "AUTHOR"
290 Made by
291 Øyvind A. Holm
292 <sunny@sunbase.org>.
293 .SH "COPYRIGHT"
295 Copyleft \(co
296 Øyvind A. Holm
297 <sunny@sunbase.org>. This is free software; see the file
298 \fICOPYING\fR
299 for legalese stuff.
300 .SH "LICENSE"
302 This program is free software; you can redistribute it and/or modify it under the terms of the
303 GNU General Public License
304 as published by the
305 Free Software Foundation; either version 2 of the License, or (at your option) any later version.
307 This program is distributed in the hope that it will be useful, but
308 \fIWITHOUT ANY WARRANTY\fR; without even the implied warranty of
309 \fIMERCHANTABILITY\fR
311 \fIFITNESS FOR A PARTICULAR PURPOSE\fR. See the GNU General Public License for more details.
313 You should have received a copy of the GNU General Public License along with this program; if not, write to
315 .RS 4
317 The Free Software Foundation, Inc.
318 59 Temple Place, Suite 330
319 Boston, MA 02111\-1307
323 .SH "SEE ALSO"
325 \fBgpsbabel\fR(1)