summaryrefslogtreecommitdiff
path: root/man/gpxlogger.xml
blob: 7d429941ca70a547b7f5ee2a40a11651f52f0180 (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
This file is Copyright (c) 2017 by the GPSD project
SPDX-License-Identifier: BSD-2-clause
-->
<!DOCTYPE refentry PUBLIC
   "-//OASIS//DTD DocBook XML V4.1.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='gpxlogger.1'>
<refentryinfo><date>05 Mar 2017</date></refentryinfo>
<refmeta>
<refentrytitle>gpxlogger</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">The GPSD Project</refmiscinfo>
<refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>gpxlogger</refname>
<refpurpose>Tool to connect to gpsd and generate a GPX file</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>

<cmdsynopsis>
  <command>gpxlogger</command>
      <arg choice='opt'>-D <replaceable>debug-level</replaceable></arg>
      <arg choice='opt'>-d </arg>
      <arg choice='opt'>-e <replaceable>export-method</replaceable></arg>
      <arg choice='opt'>-f <replaceable>filename</replaceable></arg>
      <arg choice='opt'>-l </arg>
      <arg choice='opt'>-m <replaceable>minmove</replaceable></arg>
      <arg choice='opt'>-h </arg>
      <arg choice='opt'>-V </arg>
      <arg choice='opt'>-i <replaceable>track timeout</replaceable></arg>
      <group>
	<replaceable>server</replaceable>
	  <group>
	    <replaceable>:port</replaceable>
	      <group><replaceable>:device</replaceable></group>
	  </group>
      </group>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>This program collects fixes from <application>gpsd</application>
and logs them to standard output in GPX, an XML profile for track
logging.</para>

<para>The output may be composed of multiple tracks. A new track is
created if there's no fix written for an interval specified by the
<option>-i</option> and defaulting to 5 seconds.</para>

<para><application>gpxlogger</application> can use any of the
export methods that <application>gpsd</application> supports.
For a list of these methods, use the <option>-l</option>.
To force the method, give the <option>-e</option> one of
the colon-terminated method names from the <option>-l</option>
table.</para>
</refsect1>

<refsect1 id='options'><title>OPTIONS</title>

<para>The <option>-h</option> option causes <application>gpxlogger</application>
to emit a summary of its options and then exit.</para>

<para>The <option>-V</option> option causes <application>gpxlogger</application>
to dump the package version and exit.</para>

<para> The <option>-D</option> option sets a debug level;
it is primarily for use by GPSD developers.
It enables various progress messages to standard error.</para>

<para>The <option>-d</option> option tells
<application>gpxlogger</application> to run as a daemon in background.
It requires the <option>-f</option> option, which directs output to a
specified logfile.</para>

<para>The <option>-m</option> option sets a minimum move distance in
meters (it may include a fractional decimal part).  Motions shorter
than this will not be logged.</para>

<para>The <option>-r</option> option tells
<application>gpxlogger</application> to retry when GPSd loses the fix.
Without <option>-r</option>, <application>gpxlogger</application>
would quit in this case.</para>

<para>If D-Bus support is available on the host, GPSD is configured to
use it, and <command>-e dbus</command> is specified, this program
listens to DBUS broadcasts from
<application>gpsd</application> via org.gpsd.fix.</para>

<para>With <command>-e sockets</command>, or if sockets is the method
defaulted to, you may give a server-port-device specification as
arguments.</para>

<para>The sockets default is to all devices on the localhost,
using the default GPSD port 2947. An optional argument to any
client may specify a server to get data from. A colon-separated suffix
is taken as a port number. If there is a second colon-separated
suffix, that is taken as a specific device name to be
watched. However, if the server specification contains square
brackets, the part inside them is taken as an IPv6 address and
port/device suffixes are only parsed after the trailing bracket.
Possible cases look like this:</para>

<variablelist>
<varlistentry>
<term>localhost:/dev/ttyS1</term>
<listitem><para>Look at the default port of localhost, trying both
IPv4 and IPv6 and watching output from serial device 1.</para></listitem>
</varlistentry>
<varlistentry>
<term>example.com:2317</term>
<listitem><para>Look at port 2317 on example.com, trying both
IPv4 and IPv6.</para></listitem>
</varlistentry>
<varlistentry>
<term>71.162.241.5:2317:/dev/ttyS3</term>
<listitem><para>Look at port 2317 at the specified IPv4
address, collecting data from attached serial device 3.</para></listitem>
</varlistentry>
<varlistentry>
<term>[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5</term>
<listitem><para>Look at port 2317 at the specified IPv6
address, collecting data from attached serial device 5.</para></listitem>
</varlistentry>
</variablelist>

</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<citerefentry><refentrytitle>gpspipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>

<refsect1 id='maintainer'><title>AUTHORS</title>

<para>
  Amaury Jacquot <email>sxpert@sxpert.org</email> &amp;
  Petter Reinholdtsen <email>pere@hungry.com</email> &amp;
  Chris Kuethe <email>chris.kuethe@gmail.com</email>
</para>

</refsect1>

</refentry>