also rename the itrax manpage

1 files changed, 95 insertions, 0 deletions

diff --git a/itraxctl.xml b/itraxctl.xml
new file mode 100644
index 00000000..c75c47d0
--- /dev/null
+++ b/itraxctl.xml
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC 
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='itraxctl.1'>
+<refmeta>
+<refentrytitle>itraxctl</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='date'>23 Oct 2006</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>itraxctl</refname>
+<refpurpose>Control the modes of an iTrax GPS</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>itraxctl</command>  
+      <arg choice='opt'>-n </arg>
+      <arg choice='opt'>-b </arg>
+      <arg choice='opt'>-s <replaceable>speed</replaceable></arg>
+      <arg choice='plain'><replaceable>serial-port</replaceable></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para><application>itraxctl</application> switches an iTrax GPS to NMEA
+or iTalk Binary mode. Port speed and protocol can be set independently of
+eachother.</para>
+
+<para>You will probably need to be root to run this program, as the
+serial device it uses is normally privileged.</para>
+
+<para>The program accepts the following options:</para>
+<variablelist remap='TP'>
+
+<varlistentry>
+<term>-b</term>
+<listitem>
+<para>Force GPS into binary mode. This option overrides any previous
+-n options.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>-n</term>
+<listitem>
+<para>Force GPS into NMEA mode. This option overrides any previous
+-b options.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>-s</term>
+<listitem>
+<para>Set port speed. iTrax chipsets support speeds of 4.8 - 921.6 kbps
+though the *NIX drivers might not run faster than 230.4 kbps. Fastrax
+recommends that a serial port not be run slower than 115.2 kbps when the
+iTalk protocol is selected.</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+
+</refsect1>
+
+<refsect1 id='bugs'><title>BUGS AND LIMITATIONS</title>
+
+<para>Setting NMEA mode from binary mode does not yet work. This is being
+actively investigated. Integrated data logging control is planned but not
+yet supported.</para>
+
+</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>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>libgpsd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>gpsprof</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>gpsfake</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>gnuplot</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+</para>
+</refsect1>
+
+<refsect1 id='maintainer'><title>AUTHOR</title> 
+
+<para>Chris Kuethe <email>chris.kuethe@gmail.com</email>.
+This code is part of the gpsd toolset; there is a
+project page for <application>gpsd</application> <ulink
+url="http://gpsd.berlios.de/">here</ulink>.</para> </refsect1>
+
+</refentry>
+