Document gpsdctl.xml.

1 files changed, 72 insertions, 0 deletions

diff --git a/gpsdctl.xml b/gpsdctl.xml
new file mode 100644
index 00000000..85c632d2
--- /dev/null
+++ b/gpsdctl.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+This file is Copyright (c) 2010 by the GPSD project
+BSD terms apply: see the file COPYING in the distribution root for details.
+-->
+<!DOCTYPE refentry PUBLIC
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<refentry id='gpsctl.1'>
+<refentryinfo><date>25 Jun 2011</date></refentryinfo>
+<refmeta>
+<refentrytitle>gpsdctl</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class="source">The GPSD Project</refmiscinfo>
+<refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>gpsdctl</refname>
+<refpurpose></refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>gpsctl</command>
+ 	<arg choice='plain'><replaceable>action</replaceable></arg>
+ 	<arg choice='plain'><replaceable>device</replaceable></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para>This is a tool for sending an instance of
+<application>gpsd</application> commands over its control socket to
+add or remove devices from the daemon's device list. It is not
+intended to be called by users, but rather by the Linux hotplug
+system and similar facilities.</para>
+
+<para>The action argument may be "add" or "remove". If no daeon instance is running when an add is requested, this program will launch one.</para>
+
+<para>The "device" argument should be the pathname of a device. A
+device on the list will be opened to read sensor data whenever a
+client requests a watch.</para>
+
+<para>Two environment variables are
+interpreted. <envar>GPSD_SOCKET</envar> sets the location of the
+control socket.  It defaults to <filename>/var/run/gpsd.sock</filename>.</para>
+
+<para><envar>GPSD_OPTIONS</envar>
+may be a list of options to be passed to <application>gpsd</application> 
+when this tool launches it.  It defaults to an empty string.</para>
+
+</refsect1>
+
+<refsect1 id='see_also'><title>SEE ALSO</title>
+<para>
+<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>gpsctl</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>.
+</para>
+</refsect1>
+
+<refsect1 id='maintainer'><title>AUTHOR</title>
+
+<para>Eric S. Raymond <email>esr@thyrsus.com</email>.  There is a
+project page for <application>gpsd</application> <ulink
+url="http://gpsd.berlios.de/">here</ulink>.</para>
+</refsect1>
+</refentry>