Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

171 lines
4.9 KiB

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!--
  3. This file is Copyright (c) 2010 by the GPSD project
  4. SPDX-License-Identifier: BSD-2-clause
  5. -->
  6. <!DOCTYPE refentry PUBLIC
  7. "-//OASIS//DTD DocBook XML V4.1.2//EN"
  8. "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
  9. <refentry id='gpsinit.8'>
  10. <refentryinfo><date>18 Jan 2013</date></refentryinfo>
  11. <refmeta>
  12. <refentrytitle>gpsinit</refentrytitle>
  13. <manvolnum>8</manvolnum>
  14. <refmiscinfo class="source">The GPSD Project</refmiscinfo>
  15. <refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
  16. </refmeta>
  17. <refnamediv id='name'>
  18. <refname>gpsinit</refname>
  19. <refpurpose>initialize CAN kernel modules for GPSD</refpurpose>
  20. </refnamediv>
  21. <refsynopsisdiv id='synopsis'>
  22. <cmdsynopsis>
  23. <command>gpsinit</command>
  24. <arg choice='opt'>-n <replaceable>control</replaceable></arg>
  25. <arg choice='opt'>-s <replaceable>speed</replaceable></arg>
  26. <arg choice='plain'><replaceable>module_name</replaceable></arg>
  27. <arg choice='opt'><replaceable>interface_name</replaceable></arg>
  28. </cmdsynopsis>
  29. <cmdsynopsis>
  30. <command>gpsinit</command>
  31. <arg choice='plain'>-h </arg>
  32. </cmdsynopsis>
  33. <cmdsynopsis>
  34. <command>gpsinit</command>
  35. <arg choice='plain'>-v </arg>
  36. </cmdsynopsis>
  37. </refsynopsisdiv>
  38. <refsect1 id='description'><title>DESCRIPTION</title>
  39. <para><application>gpsinit</application> initializes whatever
  40. kernel-level modules are needed to enable special non-serial hardware
  41. to communicate with a gpsd instance. Note: it will need root permissions
  42. to load modules and perform other special operations, such as changing
  43. kernel-interface baudrates.</para>
  44. <para>At present, all modes of this tool are concerned with setting up
  45. kernel-level interfaces to hardware on a CAN (Control Area Network) speaking
  46. NMEA2000.</para>
  47. <para>The program accepts the following options:</para>
  48. <variablelist remap='TP'>
  49. <varlistentry>
  50. <term>-h</term>
  51. <listitem>
  52. <para>Display a brief help text.</para>
  53. </listitem>
  54. </varlistentry>
  55. <varlistentry>
  56. <term>-v</term>
  57. <listitem>
  58. <para>Display the version of <application>gpsinit</application>.</para>
  59. </listitem>
  60. </varlistentry>
  61. <varlistentry>
  62. <term>-n</term>
  63. <listitem>
  64. <para>Set the CAN network number. The default is 0.</para>
  65. </listitem>
  66. </varlistentry>
  67. <varlistentry>
  68. <term>-s</term>
  69. <listitem>
  70. <para>Set the baudrate to be used to communicate over the serial line
  71. to the CAN hardware. The default is 38400 baud.</para>
  72. </listitem>
  73. </varlistentry>
  74. </variablelist>
  75. <para>The parameter <parameter>module_name</parameter> is mandatory. The
  76. socket CAN driver module <parameter>module_name</parameter>.ko will be
  77. loaded. <command>gpsinit</command> recognize the following module
  78. names:
  79. <variablelist>
  80. <varlistentry>
  81. <term>plx_pci</term>
  82. <term>esd_usb2</term>
  83. <term>vcan</term>
  84. <term>slcan</term>
  85. <listitem>
  86. <para>
  87. The parameter <parameter>interface_name</parameter> and <parameter>-s
  88. <replaceable>speed</replaceable></parameter> can used here.
  89. </para>
  90. </listitem>
  91. </varlistentry>
  92. <varlistentry><term>beaglebone</term>
  93. <listitem>
  94. <para> The dcan module needed for the beaglebone is part of the Linux kernel,
  95. so no module is loaded in this case.</para>
  96. </listitem>
  97. </varlistentry>
  98. </variablelist>
  99. </para>
  100. <para>The parameter <parameter>interface_name</parameter> is needed for
  101. slcan hardware only. It gives the name of the serial device to which the SL
  102. CAN hardware is connected. The default is /dev/ttyUSB0.
  103. </para>
  104. </refsect1>
  105. <refsect1 id='examples'><title>EXAMPLES</title>
  106. <variablelist>
  107. <varlistentry>
  108. <term><command>sudo gpsinit plx_pci</command></term>
  109. <listitem>
  110. <para>Attempt to load the module plx_pci and initialize net 0 for the
  111. connection to a NMEA2000 network. It will set the baudrate to
  112. 250kBits.</para>
  113. </listitem>
  114. </varlistentry>
  115. <varlistentry>
  116. <term><command>sudo gpsinit -n 1 plx_pci</command></term>
  117. <listitem>
  118. <para>As above, but use net 1.</para>
  119. </listitem>
  120. </varlistentry>
  121. <varlistentry>
  122. <term><command>sudo gpsinit -s 38400 slcan /dev/ttyUSB0</command></term>
  123. <listitem>
  124. <para>Attempt to load the module slcan and talk to the hardware at
  125. 38400 baud connected to port /dev/ttyUSB0.</para>
  126. </listitem>
  127. </varlistentry>
  128. <varlistentry>
  129. <term><command>gpsinit -h </command></term>
  130. <listitem>
  131. <para>Display a brief help message.</para>
  132. </listitem>
  133. </varlistentry>
  134. <varlistentry>
  135. <term><command>gpsinit -v </command></term>
  136. <listitem>
  137. <para>Display the version of gpsinit.</para>
  138. </listitem>
  139. </varlistentry>
  140. </variablelist>
  141. </refsect1>
  142. <refsect1 id='see_also'><title>SEE ALSO</title>
  143. <para>
  144. <citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  145. <citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  146. <citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  147. <citerefentry><refentrytitle>libgpsmm</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
  148. </para>
  149. </refsect1>
  150. <refsect1 id='maintainer'><title>AUTHOR</title>
  151. <para>Reinhard Arlt <email>reinhard.arlt@t-online.de</email>.</para>
  152. </refsect1>
  153. </refentry>