Merge cgpxlogger into gpxlogger. Still needs some code merging in

gpslogger.c itself to avoid duplication.

1 files changed, 60 insertions, 62 deletions

diff --git a/gps.xml b/gps.xml
index 8d667acb..47a629a3 100644
--- a/gps.xml
+++ b/gps.xml
@@ -22,8 +22,8 @@
   <command>xgps</command>  
       <arg choice='opt'><replaceable>X-options</replaceable></arg>
       <arg choice='opt'>-h </arg>
-      <arg choice='opt'>-j </arg>
       <arg choice='opt'>-V </arg>
+      <arg choice='opt'>-j </arg>
       <arg choice='opt'>-speedunits <group choice='req'><arg>mph</arg><arg>kph</arg><arg>knots</arg></group></arg>
       <arg choice='opt'>-altunits <group choice='req'><arg>feet</arg><arg>meters</arg></group></arg>
       <arg choice='opt'>-l <group><arg>d</arg><arg>m</arg><arg>s</arg></group></arg>
@@ -55,8 +55,8 @@
 <cmdsynopsis>
   <command>cgps</command>  
       <arg choice='opt'>-h </arg>
-      <arg choice='opt'>-j </arg>
       <arg choice='opt'>-V </arg>
+      <arg choice='opt'>-j </arg>
       <arg choice='opt'>-speedunits <group choice='req'><arg>mph</arg><arg>kph</arg><arg>knots</arg></group></arg>
       <arg choice='opt'>-altunits <group choice='req'><arg>feet</arg><arg>meters</arg></group></arg>
       <arg choice='opt'>-l <group><arg>d</arg><arg>m</arg><arg>s</arg></group></arg>
@@ -70,19 +70,50 @@
       </group>
 </cmdsynopsis>
 <cmdsynopsis>
-  <command>gpxlogger</command> <arg><replaceable>logfile</replaceable></arg>
+  <command>gpxlogger</command>
 </cmdsynopsis>
 <cmdsynopsis>
-  <command>cgpxlogger</command>  
-      <arg choice='opt'>-s <replaceable>gpsd-server</replaceable></arg>
-      <arg choice='opt'>-p <replaceable>gpsd-port</replaceable></arg>
-      <arg choice='opt'>-i <replaceable>poll-interval</replaceable></arg>
+  <command>gpxlogger</command>  
       <arg choice='opt'>-h </arg>
+      <arg choice='opt'>-V </arg>
+      <arg choice='opt'>-j </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>These are the demonstration clients shipped with
+<application>gpsd</application>. They have some common options:</para> 
+
+<para>The <option>-h</option> option causes each client to emit a summary of its
+options and then exit.</para>
+
+<para>The <option>-V</option> option causes each client to dump the package
+version and exit.</para>
+
+<para>The <option>-j</option> option, where present, tells the daemon
+to hold fix data across cycles, eliminating jitter from NMEA devices
+that emit several partial reports.  The downside is that with this
+switch on the client will occasionally report stale or invalid data
+held over from a previous cycle.  This option is ineffective, and not
+needed, on SiRFs and most other non-NMEA GPSes.  See also the
+discussion of the J command in
+<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+
+<para>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 device
+name to be handed to the daemon in an F= command (or
+equivalent).</para>
+
 <refsect2><title>xgps</title>
 
 <para><application>xgps</application> is a simple test client for
@@ -96,15 +127,6 @@ dB. Diamond icons indicate WAAS/EGNOS satellites, circles indicate
 ordinary GPS satellites.  Filled icons were used in the last fix, 
 outline icons were not.</para>
 
-<para><application>xgps</application> accepts an -h option as for
-<application>gpsd</application>, or a -V option to dump the package
-version and exit.</para>
-
-<para>An optional argument 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 device name to be handed
-to the daemon in an F= command.</para>
-
 <para>The <option>-speedunits</option> option can be used to set the
 speed units for display; follow the keyword with knots for nautical
 miles per hour, kph for kilometres per hour, or mph for miles per
@@ -116,13 +138,6 @@ altitude units for display; follow the keyword with 'meters' or
 'feet'.  The default is feet.  This option can also be set as the X
 resource 'altunits'.</para>
 
-<para>The <option>-j</option> option tells the daemon to hold fix data
-across cycles, eliminating jitter from NMEA devices that emit several
-partial reports.  The downside is that with this switch on the client
-will occasionally report stale or invalid data held over from a
-previous cycle.  This option is ineffective, and not needed, on
-SiRFs and most other non-NMEA GPSes.</para>
-
 <para> The <option>-l</option> option sets the format of latitude and 
 longitude reports.  The value 'd' produces decimal degrees and is the
 default.  The value 'm' produces degrees and decimal minutes.  The
@@ -157,18 +172,15 @@ satellite display and able to run on a serial terminal or
 terminal emulator.</para>
 
 <para> The <option>-s</option> option prevents <application>cgps</application>
-from printing the raw data. This display can also be toggled with the s
+from displaying the raw data. This display can also be toggled with the s
 command.</para>
 
-<para>The <option>-j</option> option is as described for xgps above.</para>
-
 <para>The <option>-m</option> option will display your magnetic
-  heading (as opposed to your true heading).  This is a calculated
-  value, not a measured value, and is subject to a potential error of
-  up to two degrees in the areas for which the calculation is valid
-  (currently Western Europe, Alaska, and Lower 48 in the USA).  The
-  formulas used are those found in the Aviation Formulary
-  v1.43.</para>
+heading (as opposed to your true heading).  This is a calculated
+value, not a measured value, and is subject to a potential error of up
+to two degrees in the areas for which the calculation is valid
+(currently Western Europe, Alaska, and Lower 48 in the USA).  The
+formulas used are those found in the Aviation Formulary v1.43.</para>
 
 <para>Rather than use X resources to determine which units to use, 
 <application>cgps</application> looks at variables in its environment.
@@ -195,41 +207,27 @@ Here are the variables and values it checks:</para>
 SIGHUP or SIGINT; given default terminal settings this will happen
 when you type Ctl-C at it.  It will also terminate on 'q'</para>
 
-<para>The 'j' command toggles whether or not fix data is cleared at
-start of cycle; see the description of the <option>-j</option> of 
-xgps (above) and
-<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-for discussion.</para>
-
-</refsect2>
-<refsect2><title>cgpxlogger</title>
-
-<para>This program connects to gpsd, polls for location, and logs
-each fix to standard output in GPX (XML) format.</para>
-
-<para>The <option>-s</option> and <option>-p</option> options can be
-used to specify a server and port to query.</para>
-
-<para>The <option>-i</option> option sets the poll interval at which
-the logger will collect samples.</para>
-
-<para>The <option>-j</option> option is as described for xgps above.</para>
-
-<para>The <option>-h</option> option causes the program to emit a summary of its
-options and then exit.</para>
-
-<para>The program also writes start and end messages to syslog.</para>
-
 </refsect2>
 <refsect2><title>gpxlogger</title>
 
-<para>This program listens to DBUS broadcasts from gpsd (org.gpsd.fix)
-and logs each fix to standard output as they arrive in an XML format.</para>
+<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 for 5 seconds.</para>
-
-<para>The program also writes start and end messages to syslog.</para>
+created if there's no fix for an interval specified by the
+<option>-i</option> and defaulting to 5 seconds.</para>
+
+<para>If D-Bus support is available on the host and GPSD is
+configured  to use it, this program listens to DBUS broadcasts 
+from <application>gpsd</application>. (org.gpsd.fix).  Otherwise,
+it uses a conventional socket connection. </para>
+
+<para>The <option>-j</option> option is only meaningful in socket mode
+and when collecting fixes from an NMEA device.  Presence of a
+server-port-device specification forces use of sockets even on a D-Bus
+capable system, though this is unlikely to be of interest to anyone
+except GPSD developers.</para>
 
 </refsect2>
 </refsect1>