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.
 
 
 
 
 
 

227 lines
9.2 KiB

  1. '\" t
  2. .\" Title: gps
  3. .\" Author: [see the "AUTHORS" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 9 Aug 2004
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "GPS" "1" "9 Aug 2004" "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. cgps, gegps, gps, lcdgps, xgps, xgpsspeed \- test clients for gpsd
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBcgps\fR\ 'u
  34. \fBcgps\fR [\-D\ \fIdebug\-level\fR] [\-h] [\-l\ [[d]\ |\ [m]\ |\ [s]]] [\-m] [\-s] [\-u\ [[i]\ |\ [n]\ |\ [m]]] [\-V] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
  35. .HP \w'\fBgegps\fR\ 'u
  36. \fBgegps\fR [\-d\ \fIdirectory\fR] [\-h] [\-i] [\-V]
  37. .HP \w'\fBlcdgps\fR\ 'u
  38. \fBlcdgps\fR [\-h] [\-j] [\-l\ [[d]\ |\ [m]\ |\ [s]]] [\-s] [\-u\ [[i]\ |\ [n]\ |\ [m]]] [\-V] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
  39. .HP \w'\fBxgps\fR\ 'u
  40. \fBxgps\fR [\-?] [\-D\ \fIdebug\-level\fR] [\-h] [\-l\ [[d]\ |\ [m]\ |\ [s]]] [\-u\ [[i]\ |\ [n]\ |\ [m]]] [\-r\ \fIdegrees\fR] [\-V] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
  41. .HP \w'\fBxgpsspeed\fR\ 'u
  42. \fBxgpsspeed\fR [\-\-debug\ \fIdebug\-level\fR] [\-\-device\ \fIdevice\fR] [\-h] [\-\-host\ \fIhost\fR] [\-\-landspeed] [\-\-maxspeed\ \fImaxspeed\fR] [\-\-nautical] [\-\-port\ \fIport\fR] [\-\-speedunits\ {[mph]\ |\ [kph]\ |\ [knots]}] [\-V] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
  43. .SH "DESCRIPTION"
  44. .PP
  45. These are the demonstration clients shipped with
  46. gpsd\&. They have some common options:
  47. .PP
  48. The
  49. \fB\-h\fR
  50. option causes each client to emit a summary of its options and then exit\&.
  51. .PP
  52. The
  53. \fB\-V\fR
  54. option causes each client to dump the package version and exit\&.
  55. .PP
  56. The
  57. \fB\-l\fR
  58. option, when present, sets the format of latitude and longitude reports\&. The value \*(Aqd\*(Aq produces decimal degrees and is the default\&. The value \*(Aqm\*(Aq produces degrees and decimal minutes\&. The value \*(Aqs\*(Aq produces degrees, minutes, and decimal seconds\&.
  59. .PP
  60. xgps,
  61. cgps, and
  62. lcdgps
  63. look at variables in the environment to figure out what units they should default to using for display \(em imperial, nautical, or metric\&. Here are the variables and values they check:
  64. .sp
  65. .if n \{\
  66. .RS 4
  67. .\}
  68. .nf
  69. GPSD_UNITS one of:
  70. imperial = miles/feet
  71. nautical = knots/feet
  72. metric = km/meters
  73. LC_MEASUREMENT
  74. en_US = miles/feet
  75. C = miles/feet
  76. POSIX = miles/feet
  77. [other] = km/meters
  78. LANG
  79. en_US = miles/feet
  80. C = miles/feet
  81. POSIX = miles/feet
  82. [other] = km/meters
  83. .fi
  84. .if n \{\
  85. .RE
  86. .\}
  87. .PP
  88. These preferences may be overridden by the
  89. \fB\-u\fR
  90. option\&.
  91. .PP
  92. Where present, the
  93. \fB\-u\fR
  94. option can be used to set the system units for display; follow the keyword with \*(Aqi\*(Aq for \*(Aqimperial\*(Aq for American units (International Feet in altitude and error estimates, miles per hour in speeds), \*(Aqn\*(Aq for \*(Aqnautical\*(Aq (feet in altitude and error estimates, knots in speed) or \*(Aqm\*(Aq for \*(Aqmetric\*(Aq (meters in altitude and error estimates, kilometers per hour in speeds)\&.
  95. .PP
  96. Note: The USA Survey Foot is not supported\&.
  97. .PP
  98. The
  99. \fB\-D\fR
  100. option, when present, sets a debug level; it is primarily for use by GPSD developers\&. It enables various progress messages to standard error\&.
  101. .PP
  102. By default, clients collect data from all compatible devices on localhost, using the default GPSD port 2947\&. An optional argument to any client may specify a server to get data from\&. A colon\-separated suffix is taken as a port number\&. If there is a second colon\-separated suffix, that is taken as a specific device name to be watched\&. However, if the server specification contains square brackets, the part inside them is taken as an IPv6 address and port/device suffixes are only parsed after the trailing bracket\&. Possible cases look like this:
  103. .PP
  104. The options for xgps can be placed in the XGPSOPTS environment variable\&. XGPSOPTS is processed before the CLI options\&.
  105. .PP
  106. localhost:/dev/ttyS1
  107. .RS 4
  108. Look at the default port of localhost, trying both IPv4 and IPv6 and watching output from serial device 1\&.
  109. .RE
  110. .PP
  111. example\&.com:2317
  112. .RS 4
  113. Look at port 2317 on example\&.com, trying both IPv4 and IPv6\&.
  114. .RE
  115. .PP
  116. 71\&.162\&.241\&.5:2317:/dev/ttyS3
  117. .RS 4
  118. Look at port 2317 at the specified IPv4 address, collecting data from attached serial device 3\&.
  119. .RE
  120. .PP
  121. [FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5
  122. .RS 4
  123. Look at port 2317 at the specified IPv6 address, collecting data from attached serial device 5\&.
  124. .RE
  125. .PP
  126. Not all clients shipped with GPSD are documented here\&. See also the separate manual pages for
  127. \fBgpspipe\fR(1)
  128. and
  129. \fBgpsmon\fR(1)
  130. and
  131. \fBgpxlogger\fR(1)
  132. \&.
  133. .SS "xgps"
  134. .PP
  135. xgps
  136. is a simple test client for
  137. gpsd
  138. with an X interface\&. It displays current GPS position/time/velocity information and (for GPSes that support the feature) the locations of accessible satellites\&.
  139. .PP
  140. In the sky view, satellites are color\-coded to indicate quality of signal; consult the data display to the left for exact figures in dB\&. Square icons indicate SBAS/WAAS/EGNOS satellites, circles indicate ordinary GPS satellites\&. Filled icons were used in the current fix, outline icons were not\&.
  141. .PP
  142. The \-r option accepts an argument in degrees, to rotate the skyview counterclockwise\&.
  143. .SS "xgpsspeed"
  144. .PP
  145. xgpsspeed
  146. is a speedometer that uses position information from the GPS\&. It accepts an \-h option and optional argument as for
  147. gps, or a \-V option to dump the package version and exit\&.
  148. .PP
  149. The default display mode is a speed and track presentation modeled after a marine navigation display; for backward compatibility the \-\-nautical option forces this mode\&. The \-\-landspeed option produces a simple speedometer\&.
  150. .PP
  151. The \-speedunits option can be used to set the speed units for display; follow the keyword with knots for nautical miles per hour, kph for kilometres per hour, or mph for miles per hour\&. The default is miles per hour\&.
  152. .PP
  153. In the nautical mode only, \-\-maxspeed sets the maximum on the speedometer\&.
  154. .SS "cgps"
  155. .PP
  156. cgps
  157. is a client resembling
  158. xgps, but without the pictorial satellite display and able to run on a serial terminal or terminal emulator\&.
  159. .PP
  160. The
  161. \fB\-s\fR
  162. option prevents
  163. cgps
  164. from displaying the data coming from the daemon\&. This display can also be toggled with the s command\&.
  165. .PP
  166. The
  167. \fB\-m\fR
  168. option will display your magnetic track (as opposed to your true track)\&. This is a calculated value, not a measured value\&. Magnetic variation is always potentially subject to large errors, but is usually better than two degrees\&.
  169. .PP
  170. cgps
  171. terminates when you send it a SIGHUP or SIGINT; given default terminal settings this will happen when you type Ctrl\-C at it\&. It will also terminate on \*(Aqq\*(Aq
  172. .SS "lcdgps"
  173. .PP
  174. A client that passes
  175. gpsd
  176. data to
  177. lcdproc, turning your car computer into a very expensive and nearly feature\-free GPS receiver\&. Currently assumes a 4x40 LCD and writes data formatted to fit that size screen\&. Also displays 4\- or 6\-character Maidenhead grid square output\&.
  178. .SS "gegps"
  179. .PP
  180. This program collects fixes from
  181. gpsd
  182. and feeds them to a running instance of Google Earth for live location tracking\&.
  183. .PP
  184. The
  185. \fB\-d\fR
  186. argument is the location of the Google Earth installation directory\&. If not specified, it defaults to the current directory\&.
  187. .PP
  188. If you have the free (non\-subscription) version, start by running with the
  189. \fB\-i\fR
  190. option to drop a clue in the Google Earth installation directory, as \*(AqOpen_in_Google_Earth_RT_GPS\&.kml\*(Aq, then open that file in Places (File > Open\&.\&.\&.)\&. Run
  191. gegps
  192. in the normal way after that\&.
  193. .SH "ENVIRONMENT"
  194. .PP
  195. The
  196. \fBXGPSOPTS>\fR
  197. environment variable may be set to pass commonly used command line options to
  198. \fBxgps\fR
  199. and
  200. \fBxgpsspeed\fR\&. This is often used to set the
  201. \fB\-u\fR
  202. option for locale specific units\&.
  203. \fBXGPSOPTS\fR
  204. is processed before the CLI options\&.
  205. .SH "SEE ALSO"
  206. .PP
  207. \fBgpsd\fR(8),
  208. \fBlibgps\fR(3),
  209. \fBlibgpsmm\fR(3),
  210. \fBgpsfake\fR(1),
  211. \fBgpsctl\fR(1),
  212. \fBgpscat\fR(1),
  213. \fBgpsprof\fR(1)\&.
  214. \fBgpspipe\fR(1)\&.
  215. \fBgpsmon\fR(1)\&.
  216. \fBgpxlogger\fR(1)\&.
  217. .SH "AUTHORS"
  218. .PP
  219. Remco Treffcorn, Derrick Brashear, Russ Nelson & Eric S\&. Raymond, Jeff Francis (cgps), Chen Wei
  220. <weichen302@aol\&.com>
  221. (gegps & xgpsspeed), Robin Wittler
  222. <real@the\-real\&.org>
  223. (xgpsspeed)\&.
  224. .PP
  225. This manual page by Eric S\&. Raymond
  226. <esr@thyrsus\&.com>