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.
 
 
 
 
 
 

129 lines
3.6 KiB

  1. '\" t
  2. .\" Title: gpsinit
  3. .\" Author: [see the "AUTHOR" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 18 Jan 2013
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "GPSINIT" "8" "18 Jan 2013" "The GPSD Project" "GPSD Documentation"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. gpsinit \- initialize CAN kernel modules for GPSD
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBgpsinit\fR\ 'u
  34. \fBgpsinit\fR [\-n\ \fIcontrol\fR] [\-s\ \fIspeed\fR] \fImodule_name\fR [\fIinterface_name\fR]
  35. .HP \w'\fBgpsinit\fR\ 'u
  36. \fBgpsinit\fR \-h
  37. .HP \w'\fBgpsinit\fR\ 'u
  38. \fBgpsinit\fR \-v
  39. .SH "DESCRIPTION"
  40. .PP
  41. gpsinit
  42. 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\&.
  43. .PP
  44. 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\&.
  45. .PP
  46. The program accepts the following options:
  47. .PP
  48. \-h
  49. .RS 4
  50. Display a brief help text\&.
  51. .RE
  52. .PP
  53. \-v
  54. .RS 4
  55. Display the version of
  56. gpsinit\&.
  57. .RE
  58. .PP
  59. \-n
  60. .RS 4
  61. Set the CAN network number\&. The default is 0\&.
  62. .RE
  63. .PP
  64. \-s
  65. .RS 4
  66. Set the baudrate to be used to communicate over the serial line to the CAN hardware\&. The default is 38400 baud\&.
  67. .RE
  68. .PP
  69. The parameter
  70. \fImodule_name\fR
  71. is mandatory\&. The socket CAN driver module
  72. \fImodule_name\fR\&.ko will be loaded\&.
  73. \fBgpsinit\fR
  74. recognize the following module names:
  75. .PP
  76. plx_pci, esd_usb2, vcan, slcan
  77. .RS 4
  78. The parameter
  79. \fIinterface_name\fR
  80. and
  81. \fI\-s \fR\fI\fIspeed\fR\fR
  82. can used here\&.
  83. .RE
  84. .PP
  85. beaglebone
  86. .RS 4
  87. The dcan module needed for the beaglebone is part of the Linux kernel, so no module is loaded in this case\&.
  88. .RE
  89. .PP
  90. The parameter
  91. \fIinterface_name\fR
  92. is needed for slcan hardware only\&. It gives the name of the serial device to which the SL CAN hardware is connected\&. The default is /dev/ttyUSB0\&.
  93. .SH "EXAMPLES"
  94. .PP
  95. \fBsudo gpsinit plx_pci\fR
  96. .RS 4
  97. Attempt to load the module plx_pci and initialize net 0 for the connection to a NMEA2000 network\&. It will set the baudrate to 250kBits\&.
  98. .RE
  99. .PP
  100. \fBsudo gpsinit \-n 1 plx_pci\fR
  101. .RS 4
  102. As above, but use net 1\&.
  103. .RE
  104. .PP
  105. \fBsudo gpsinit \-s 38400 slcan /dev/ttyUSB0\fR
  106. .RS 4
  107. Attempt to load the module slcan and talk to the hardware at 38400 baud connected to port /dev/ttyUSB0\&.
  108. .RE
  109. .PP
  110. \fBgpsinit \-h \fR
  111. .RS 4
  112. Display a brief help message\&.
  113. .RE
  114. .PP
  115. \fBgpsinit \-v \fR
  116. .RS 4
  117. Display the version of gpsinit\&.
  118. .RE
  119. .SH "SEE ALSO"
  120. .PP
  121. \fBgpsd\fR(8),
  122. \fBgps\fR(1),
  123. \fBlibgps\fR(3),
  124. \fBlibgpsmm\fR(3)\&.
  125. .SH "AUTHOR"
  126. .PP
  127. Reinhard Arlt
  128. <reinhard\&.arlt@t\-online\&.de>\&.