1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!--
3This file is Copyright (c) 2017 by the GPSD project
4SPDX-License-Identifier: BSD-2-clause
5-->
6<!DOCTYPE refentry PUBLIC
7   "-//OASIS//DTD DocBook XML V4.1.2//EN"
8   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
9<refentry id='gpxlogger.1'>
10<refentryinfo><date>05 Mar 2017</date></refentryinfo>
11<refmeta>
12<refentrytitle>gpxlogger</refentrytitle>
13<manvolnum>1</manvolnum>
14<refmiscinfo class="source">The GPSD Project</refmiscinfo>
15<refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
16</refmeta>
17<refnamediv id='name'>
18<refname>gpxlogger</refname>
19<refpurpose>Tool to connect to gpsd and generate a GPX file</refpurpose>
20</refnamediv>
21<refsynopsisdiv id='synopsis'>
22
23<cmdsynopsis>
24  <command>gpxlogger</command>
25      <arg choice='opt'>-D <replaceable>debug-level</replaceable></arg>
26      <arg choice='opt'>-d </arg>
27      <arg choice='opt'>-e <replaceable>export-method</replaceable></arg>
28      <arg choice='opt'>-f <replaceable>filename</replaceable></arg>
29      <arg choice='opt'>-l </arg>
30      <arg choice='opt'>-m <replaceable>minmove</replaceable></arg>
31      <arg choice='opt'>-h </arg>
32      <arg choice='opt'>-V </arg>
33      <arg choice='opt'>-i <replaceable>track timeout</replaceable></arg>
34      <group>
35	<replaceable>server</replaceable>
36	  <group>
37	    <replaceable>:port</replaceable>
38	      <group><replaceable>:device</replaceable></group>
39	  </group>
40      </group>
41</cmdsynopsis>
42</refsynopsisdiv>
43
44<refsect1 id='description'><title>DESCRIPTION</title>
45<para>This program collects fixes from <application>gpsd</application>
46and logs them to standard output in GPX, an XML profile for track
47logging.</para>
48
49<para>The output may be composed of multiple tracks. A new track is
50created if there's no fix written for an interval specified by the
51<option>-i</option> and defaulting to 5 seconds.</para>
52
53<para><application>gpxlogger</application> can use any of the
54export methods that <application>gpsd</application> supports.
55For a list of these methods, use the <option>-l</option>.
56To force the method, give the <option>-e</option> one of
57the colon-terminated method names from the <option>-l</option>
58table.</para>
59</refsect1>
60
61<refsect1 id='options'><title>OPTIONS</title>
62
63<para>The <option>-h</option> option causes <application>gpxlogger</application>
64to emit a summary of its options and then exit.</para>
65
66<para>The <option>-V</option> option causes <application>gpxlogger</application>
67to dump the package version and exit.</para>
68
69<para> The <option>-D</option> option sets a debug level;
70it is primarily for use by GPSD developers.
71It enables various progress messages to standard error.</para>
72
73<para>The <option>-d</option> option tells
74<application>gpxlogger</application> to run as a daemon in background.
75It requires the <option>-f</option> option, which directs output to a
76specified logfile.</para>
77
78<para>The <option>-m</option> option sets a minimum move distance in
79meters (it may include a fractional decimal part).  Motions shorter
80than this will not be logged.</para>
81
82<para>The <option>-r</option> option tells
83<application>gpxlogger</application> to retry when GPSd loses the fix.
84Without <option>-r</option>, <application>gpxlogger</application>
85would quit in this case.</para>
86
87<para>If D-Bus support is available on the host, GPSD is configured to
88use it, and <command>-e dbus</command> is specified, this program
89listens to DBUS broadcasts from
90<application>gpsd</application> via org.gpsd.fix.</para>
91
92<para>With <command>-e sockets</command>, or if sockets is the method
93defaulted to, you may give a server-port-device specification as
94arguments.</para>
95
96<para>The sockets default is to all devices on the localhost,
97using the default GPSD port 2947. An optional argument to any
98client may specify a server to get data from. A colon-separated suffix
99is taken as a port number. If there is a second colon-separated
100suffix, that is taken as a specific device name to be
101watched. However, if the server specification contains square
102brackets, the part inside them is taken as an IPv6 address and
103port/device suffixes are only parsed after the trailing bracket.
104Possible cases look like this:</para>
105
106<variablelist>
107<varlistentry>
108<term>localhost:/dev/ttyS1</term>
109<listitem><para>Look at the default port of localhost, trying both
110IPv4 and IPv6 and watching output from serial device 1.</para></listitem>
111</varlistentry>
112<varlistentry>
113<term>example.com:2317</term>
114<listitem><para>Look at port 2317 on example.com, trying both
115IPv4 and IPv6.</para></listitem>
116</varlistentry>
117<varlistentry>
118<term>71.162.241.5:2317:/dev/ttyS3</term>
119<listitem><para>Look at port 2317 at the specified IPv4
120address, collecting data from attached serial device 3.</para></listitem>
121</varlistentry>
122<varlistentry>
123<term>[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5</term>
124<listitem><para>Look at port 2317 at the specified IPv6
125address, collecting data from attached serial device 5.</para></listitem>
126</varlistentry>
127</variablelist>
128
129</refsect1>
130
131<refsect1 id='see_also'><title>SEE ALSO</title>
132<para>
133<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
134<citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
135<citerefentry><refentrytitle>gpspipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>
136</para>
137</refsect1>
138
139<refsect1 id='maintainer'><title>AUTHORS</title>
140
141<para>
142  Amaury Jacquot <email>sxpert@sxpert.org</email> &amp;
143  Petter Reinholdtsen <email>pere@hungry.com</email> &amp;
144  Chris Kuethe <email>chris.kuethe@gmail.com</email>
145</para>
146
147</refsect1>
148
149</refentry>
150