summaryrefslogtreecommitdiff
path: root/garminctl.xml
blob: 6f84c6a61f2e84367d4fcd9da0fe5864c56bfe1b (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC 
   "-//OASIS//DTD DocBook XML V4.1.2//EN"
   "docbook/docbookx.dtd">
<refentry id='garminctl.1'>
<refmeta>
<refentrytitle>garminctl</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>08 Oct 2006</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>garminctl</refname>
<refpurpose>control the modes of a Garmin GPS</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>

<cmdsynopsis>
  <command>garminctl</command>  
      <arg choice='opt'>-? </arg>
      <arg choice='opt'>-h </arg>
      <arg choice='opt'>-n </arg>
      <arg choice='opt'>-b </arg>
      <arg choice='opt'>-D <replaceable>debuglevel</replaceable></arg>
      <arg choice='opt'>-V </arg>
      <arg choice='plain'><replaceable>serial-port</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1 id='description'><title>DESCRIPTION</title>

<para><application>garminctl</application> can switch a serial Garmin 
GPS to NMEA or Garmin Binary mode.  On exit it leaves the serial
port set to the proper baud rate. </para>

<para>This program is not for use with Garmin USB devices.  Those are
permanently set to Garmin Binary mode.</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>-?</term>
<listitem>
<para>Display program usage and exit.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-b</term>
<listitem>
<para>Force GPS into binary mode.  After the GPS resets itself autobaud to 
the new speed.  Binary mode is always 9600 8N1.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-n</term>
<listitem>
<para>Force GPS into NMEA mode.  After the GPS resets itself autobaud to 
the new speed.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-h</term>
<listitem>
<para>Display program usage and exit.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-D</term>
<listitem>
<para>Set debug level.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-V</term>
<listitem>
<para>Display program version and exit.</para>
</listitem>
</varlistentry>

</variablelist>

</refsect1>

<refsect1 id='bugs'><title>BUGS AND LIMITATIONS</title>

<para>The logic for hunting the GPS's baud rate is vulnerable to
various sorts of RS232 flakiness. If it hangs for longer than a few
seconds, kill the program and restart.</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='note'><title>NOTE</title> 

<para>There are plans to merge this program with other
GPS-type-specific control utilities. Similar functionality will be
available, but name and invocation optins may be different.</para>

</refsect1>

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

<para>Gary E. Miller <email>gem@rellim.com</email>.
This code is part of the gpsd toolset; there is a
project website for <application>gpsd</application> <ulink
url="http://gpsd.berlios.de/">here</ulink>.</para> </refsect1>

</refentry>