diff options
| -rw-r--r-- | SConstruct | 1 | ||||
| -rwxr-xr-x | gpsinit (renamed from cansetup) | 2 | ||||
| -rw-r--r-- | gpsinit.xml (renamed from cansetup.xml) | 45 | ||||
| -rw-r--r-- | www/index.html.in | 8 |
4 files changed, 33 insertions, 23 deletions
@@ -1152,6 +1152,7 @@ base_manpages = { "gpsd_json.5" : "gpsd_json.xml", "gps.1" : "gps.xml", "cgps.1" : "gps.xml", + "gpsinit.8": "gpsinit.xml", "lcdgps.1" : "gps.xml", "libgps.3" : "libgps.xml", "libgpsmm.3" : "libgpsmm.xml", @@ -1,6 +1,6 @@ #!/bin/bash # -# cansetup - initialize kernel-CAN interfaces +# gpsinit - initialize kernel-CAN interfaces # # This file is Copyright (c) 2012 by the GPSD project. # BSD terms apply: see the file COPYING in the distribution root for details. diff --git a/cansetup.xml b/gpsinit.xml index 2882b937..85daaaa5 100644 --- a/cansetup.xml +++ b/gpsinit.xml @@ -6,43 +6,48 @@ 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='cansetup.1'> +<refentry id='gpsinit.8'> <refentryinfo><date>18 Jan 2013</date></refentryinfo> <refmeta> -<refentrytitle>cansetup</refentrytitle> +<refentrytitle>gpsinit</refentrytitle> <manvolnum>1</manvolnum> <refmiscinfo class="source">The GPSD Project</refmiscinfo> <refmiscinfo class="manual">GPSD Documentation</refmiscinfo> </refmeta> <refnamediv id='name'> -<refname>cansetup</refname> -<refpurpose>initialize the can interface of some known CAN hardware for the use with gpsd and NMEA2000</refpurpose> +<refname>gpsinit</refname> +<refpurpose>initialize CAN kernel modules for GPSD</refpurpose> </refnamediv> <refsynopsisdiv id='synopsis'> <cmdsynopsis> - <command>cansetup</command> + <command>gpsinit</command> <arg choice='opt'>-n <replaceable>control</replaceable></arg> <arg choice='opt'>-s <replaceable>speed</replaceable></arg> <arg choice='plain'><replaceable>module_name</replaceable></arg> <arg choice='opt'><replaceable>interface_name</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>cansetup</command> + <command>gpsinit</command> <arg choice='plain'>-h </arg> </cmdsynopsis> <cmdsynopsis> - <command>cansetup</command> + <command>gpsinit</command> <arg choice='plain'>-v </arg> </cmdsynopsis> </refsynopsisdiv> <refsect1 id='description'><title>DESCRIPTION</title> -<para><application>cansetup</application> will initalize a can -interface so that it can be used as an interface to a NMEA2000 -network. Note: It needs root permissions to load modules and change -the interface baudrate.</para> +<para><application>gpsinit</application> initializes whatever +kernel-level modules are needed to enable special non-serial hardware +to communicate with a gpsd instance. Note: it will need root permissions +to load modules and perform other special operations, such as changing +kernel-interface baudrates.</para> + +<para>At present, all modes of this tool are concerned with setting up +kernel-level interfaces to hardware on a CAN (Control Area Network) speaking +NMEA2000.</para> <para>The program accepts the following options:</para> <variablelist remap='TP'> @@ -57,14 +62,14 @@ the interface baudrate.</para> <varlistentry> <term>-v</term> <listitem> -<para>Display the version of <application>cansetup</application>.</para> +<para>Display the version of <application>gpsinit</application>.</para> </listitem> </varlistentry> <varlistentry> <term>-n</term> <listitem> -<para>Set the network number. The default is 0.</para> +<para>Set the CAN network number. The default is 0.</para> </listitem> </varlistentry> @@ -79,7 +84,7 @@ to the CAN hardware. The default is 38400 baud.</para> <para>The parameter <parameter>module_name</parameter> is mandatory. The socket CAN driver module <parameter>module_name</parameter>.ko will be -loaded. <command>cansetup</command> recognize the following module +loaded. <command>gpsinit</command> recognize the following module names: <variablelist> @@ -113,7 +118,7 @@ CAN hardware is connected. The default is /dev/ttyUSB0. <variablelist> <varlistentry> -<term><command>sudo cansetup plx_pci</command></term> +<term><command>sudo gpsinit plx_pci</command></term> <listitem> <para>Attempt to load the module plx_pci and initialize net 0 for the connection to a NMEA2000 network. It will set the baudrate to @@ -121,13 +126,13 @@ connection to a NMEA2000 network. It will set the baudrate to </listitem> </varlistentry> <varlistentry> -<term><command>sudo cansetup -n 1 plx_pci</command></term> +<term><command>sudo gpsinit -n 1 plx_pci</command></term> <listitem> <para>As above, but use net 1.</para> </listitem> </varlistentry> <varlistentry> -<term><command>sudo cansetup -s 38400 slcan /dev/ttyUSB0</command></term> +<term><command>sudo gpsinit -s 38400 slcan /dev/ttyUSB0</command></term> <listitem> <para>Attempt to load the module slcan and talk to the hardware at 38400 baud connected to port /dev/ttyUSB0.</para> @@ -135,15 +140,15 @@ connection to a NMEA2000 network. It will set the baudrate to </varlistentry> <varlistentry> -<term><command>cansetup -h </command></term> +<term><command>gpsinit -h </command></term> <listitem> <para>Display a brief help message.</para> </listitem> </varlistentry> <varlistentry> -<term><command>cansetup -v </command></term> +<term><command>gpsinit -v </command></term> <listitem> -<para>Display the version of cansetup.</para> +<para>Display the version of gpsinit.</para> </listitem> </varlistentry> </variablelist> diff --git a/www/index.html.in b/www/index.html.in index f51abf54..536943c0 100644 --- a/www/index.html.in +++ b/www/index.html.in @@ -282,8 +282,12 @@ standard output.</dd> <dt><a href="gpsdecode.html">gpsdecode.1</a></dt> <dd>The <code>gpsdecode</code> packet decoder.</dd> -<dt><a href="gpsd_json.html">gpsd.5</a></dt> -<dd>The request/response protocol of the <code>gpsd</code> daemon.</dd> +<dt><a href="gpsd_json.html">gpsd.5</a></dt> <dd>The request/response +protocol of the <code>gpsd</code> daemon.</dd> + +<dt><a href="gpsinit.html">gpsinit.8</a></dt> +<dd>Initialize kernel modules for use with <code>gpsd</code> daemon.</dd> +</dl> </dl> <p>Also, see the <a href="faq.html">FAQ</a>.</p> |