path: root/gps.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC 
   "-//OASIS//DTD DocBook XML V4.1.2//EN"
   "docbook/docbookx.dtd">
<refentry id='gps.1'>
<refmeta>
<refentrytitle>gps</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>9 Aug 2004</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>gps</refname>
<refname>xgps</refname>
<refname>xgpsspeed</refname>
<refname>cgps</refname>
<refname>lcdgps</refname>
<refname>cgpxlogger</refname>
<refpurpose>test clients for gpsd</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>

<cmdsynopsis>
  <command>xgps</command>  
      <arg choice='opt'><replaceable>X-options</replaceable></arg>
      <arg choice='opt'>-h </arg>
      <arg choice='opt'>-V </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>
      <group>
	<replaceable>server</replaceable>
	  <group> 
	    <replaceable>:port</replaceable> 
	      <group><replaceable>:device</replaceable></group>
	  </group>
      </group>
</cmdsynopsis>
<cmdsynopsis>
  <command>xgpsspeed</command> <arg choice='opt'>-rv</arg> 
      <arg choice='opt'><replaceable>X-options</replaceable></arg>
      <arg choice='opt'>-h </arg> 
      <arg choice='opt'>-V </arg> <arg
      choice='opt'>-nc <replaceable>X-color</replaceable></arg> <arg
      choice='opt'>-speedunits <group
      choice='req'><arg>mph</arg><arg>kph</arg><arg>knots</arg></group></arg>
      <group>
	<replaceable>server</replaceable>
	  <group> 
	    <replaceable>:port</replaceable> 
	      <group><replaceable>:device</replaceable></group>
	  </group>
      </group>
</cmdsynopsis>
<cmdsynopsis>
  <command>cgps</command>  
      <arg choice='opt'>-h </arg>
      <arg choice='opt'>-V </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>
      <arg choice='opt'>-m </arg>
      <arg choice='opt'>-s </arg>
      <group>
	<replaceable>server</replaceable>
	  <group> 
	    <replaceable>:port</replaceable> 
	      <group><replaceable>:device</replaceable></group>
	  </group>
      </group>
</cmdsynopsis>
<cmdsynopsis>
  <command>lcdgps</command>  
      <arg choice='opt'>-h </arg>
      <arg choice='opt'>-V </arg>
      <arg choice='opt'>-l <group><arg>d</arg><arg>m</arg><arg>s</arg></group></arg>
      <arg choice='opt'>-u <group><arg>i</arg><arg>n</arg><arg>m</arg></group></arg>
      <group>
	<replaceable>server</replaceable>
	  <group> 
	    <replaceable>:port</replaceable> 
	      <group><replaceable>:device</replaceable></group>
	  </group>
      </group>
</cmdsynopsis>
<cmdsynopsis>
  <command>gpxlogger</command>
</cmdsynopsis>
<cmdsynopsis>
  <command>gpxlogger</command>  
      <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>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>-l</option> option, when present, 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 value 's' produces degrees, minutes, and decimal
seconds.</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>

<para>Not all clients shipped with GPSD are documented here. See also
the separate manual pages for
<citerefentry><refentrytitle>gpspipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>
and
<citerefentry><refentrytitle>gpsmon</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>

<refsect2><title>xgps</title>

<para><application>xgps</application> is a simple test client for
<application>gpsd</application> with an X interface. It displays
current GPS position/time/velocity information and (for GPSes that
support the feature) the locations of accessible satellites.</para>

<para>In the sky view, satellites are color-coded to indicate quality
of signal; consult the data display to the left for exact figures in
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>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
hour.  The default is miles per hour.  This option can also be set as
the X resource 'speedunits'.</para>

<para>The <option>-altunits</option> option can be used to set the
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>There is a known bug in <application>xgps</application>; it
assumes the default font size is no more than 18 pixels.  If this
is not the case, the satellite data display will show fewer than
12 satellites.</para>

</refsect2>
<refsect2><title>xgpsspeed</title>

<para><application>xgpsspeed</application> is a speedometer that uses
position information from the GPS. It accepts an -h option and
optional argument as for <application>gps</application>, or a -V
option to dump the package version and exit.  Additionally, it accepts
-rv (reverse video) and -nc (needle color) options.</para>

<para>The -speedunits 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 hour.  The default
is miles per hour.   This option can also be set as the X resource 
'speedunits'.</para>

</refsect2>
<refsect2><title>cgps</title>

<para><application>cgps</application> is a client resembling 
<application>xgps</application>, but without the pictorial 
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 displaying the raw data. This display can also be toggled with the s
command.</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>

<para>Rather than use X resources to determine which units to use, 
<application>cgps</application> looks at variables in its environment.
Here are the variables and values it checks:</para>

<screen>
    GPSD_UNITS one of: 
              imperial   = miles/feet
              nautical   = knots/feet
              metric     = km/meters
    LC_MEASUREMENT
	      en_US      = miles/feet
              C          = miles/feet
              POSIX      = miles/feet
              [other]    = km/meters
    LANG
	      en_US      = miles/feet
              C          = miles/feet
              POSIX      = miles/feet
              [other]    = km/meters
</screen>

<para><application>cgps</application> terminates when you send it a
SIGHUP or SIGINT; given default terminal settings this will happen
when you type Ctl-C at it.  It will also terminate on 'q'</para>

</refsect2>
<refsect2><title>lcdgps</title>

<para>A client that passes <application>gpsd</application> data to
<application>lcdproc</application>, turning your car computer into a
very expensive and nearly feature-free GPS receiver.  Currently
assumes a 4x40 LCD and writes data formatted to fit that size screen.
Also displays 4- or 6-character Maidenhead grid square output.</para>

<para>Options are as for <application>cgps</application>, except: The
<option>-u</option> sets the display format the units used for
altitude and speed. The options are: <quote>i</quote> for Imperial
units (feet/miles-per-hour); <quote>n</quote> for nautical
(feet/knots); 'm' for metric (meters/kilometers-per-hour).</para>

</refsect2>
<refsect2><title>gpxlogger</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 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>
<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgpsd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpsfake</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpsctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpscat</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpsprof</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
<citerefentry><refentrytitle>gpspipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
<citerefentry><refentrytitle>gpsmon</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para>
</refsect1>

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

<para>
Remco Treffcorn, Derrick Brashear, Russ Nelson &amp; Eric S. Raymond,
Jeff Francis (cgps). Amaury Jacquot <email>sxpert@sxpert.org</email>
&amp; Petter Reinholdtsen <email>pere@hungry.com</email> (gpxlogger).
Chris Kuethe <email>chris.kuethe@gmail.com</email> (cgpxlogger).
</para>

<para>This manual page by Eric S. Raymond <email>esr@thyrsus.com</email>.
There is a project page, with <application>xgps</application>
screenshots, at <ulink url="http://gpsd.berlios.de/">berlios.de</ulink>.</para>

</refsect1>

</refentry>