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.
 
 
 
 
 
 

159 lines
5.2 KiB

  1. '\" t
  2. .\" Title: gpspipe
  3. .\" Author: [see the "AUTHOR" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 14 Dec 2018
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "GPSPIPE" "1" "14 Dec 2018" "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. gpspipe \- tool to connect to gpsd and retrieve sentences
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBgpspipe\fR\ 'u
  34. \fBgpspipe\fR [\-2] [\-?] [\-d] [\-D\ \fIdebug\-level\fR] [\-h] [\-l] [\-n\ \fIcount\fR] [\-o\ \fIfilename\fR] [\-p] [\-P] [\-r] [\-R] [\-S] [\-s\ \fIserial\-device\fR] [\-t] [\-T\ \fItimestamp\-format\fR] [\-u] [\-v] [\-V] [\-w] [\-x\ \fIseconds\fR] [\-Z] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
  35. .SH "DESCRIPTION"
  36. .PP
  37. gpspipe
  38. is a tool to connect to
  39. gpsd
  40. and output the received sentences to stdout\&. This makes the program useful as a pipe from
  41. gpsd
  42. to another program or file\&.
  43. .PP
  44. gpspipe
  45. does not require root privileges, and can be run concurrently with other tools connecting to the local
  46. gpsd
  47. without causing problems\&.
  48. .PP
  49. The output will consist of one or both of the raw NMEA or native
  50. gpsd
  51. sentences\&. Each line can be optionally time stamped\&. There is also an option to exit gracefully after a given count of packets\&.
  52. .PP
  53. Optionally a server, TCP/IP port number and remote device can be given\&. If omitted,
  54. gpspipe
  55. connects to localhost on the default port (2947) and watches all devices opened by
  56. gpsd\&.
  57. .PP
  58. gpspipe
  59. may be run as a daemon, but requires the \-o flag for writing the output to a file\&.
  60. .SH "OPTIONS"
  61. .PP
  62. \-2 sets the split24 flag on AIS reports\&. Note: this option is experimental and may be changed or removed in a future release\&.
  63. .PP
  64. \-? makes
  65. gpspipe
  66. print a usage message and exit\&.
  67. .PP
  68. \-d causes
  69. gpspipe
  70. to run as a daemon\&.
  71. .PP
  72. \-D [debug\-level] set debug level\&.\&.
  73. .PP
  74. \-h makes
  75. gpspipe
  76. print a usage message and exit\&.
  77. .PP
  78. \-l causes
  79. gpspipe
  80. to sleep for ten seconds before attempting to connect to gpsd\&. This is very useful when running as a daemon, giving gpsd time to start before attempting a connection\&.
  81. .PP
  82. \-n [count] causes [count] sentences to be output\&.
  83. gpspipe
  84. will then exit gracefully\&.
  85. .PP
  86. \-o [filename] option causes the collected data to be written to the specified file\&. Use of this option is mandatory if
  87. gpspipe
  88. is run as a daemon\&.
  89. .PP
  90. \-p enables dumping of profiling information in JSON\&.
  91. .PP
  92. \-P enables dumping of PPS drift JSON in NMEA and raw modes\&.
  93. .PP
  94. \-r causes raw NMEA sentences to be output\&.
  95. .PP
  96. \-R causes super\-raw (gps binary) data to be output\&. This overrides NMEA and gpsd output modes\&.
  97. .PP
  98. \-s option causes the collected data to be written to the specified serial device with settings 4800 8N1\&. Thus
  99. gpspipe
  100. can be used with \-s and \-r options to emulate a serial port hardwired to a GPS that
  101. gpsd
  102. is managing\&.
  103. .PP
  104. \-S sets the scaled flag\&. This is for AIS and subframe data, but currently appears to do nothing\&.
  105. .PP
  106. \-t adds a UTC timestamp to each sentence output\&.
  107. .PP
  108. \-T sets the format of the timestamp\&. See
  109. \fBstrftime\fR(3)
  110. for the available placeholders\&. Setting this option implies \-t\&. Default setting is "%F %T"
  111. .PP
  112. \-u usec resolution time stamp, implies \-t\&. Use \-uu to output sec\&.usec\&.
  113. .PP
  114. \-v causes
  115. gpspipe
  116. to show a spinning activity indicator on stderr\&. This is useful if stdout is redirected into a file or a pipe\&. By default the spinner is advanced with every messages written; specifying \-v more than once will double the number of messages required to rotate the spinner\&.
  117. .PP
  118. \-V prints the version, then exits\&.
  119. .PP
  120. \-w causes native
  121. gpsd
  122. sentences to be output\&.
  123. .PP
  124. \-x [seconds] Exit after delay of [seconds]\&.
  125. .PP
  126. \-Z sets the timestamp format iso8601: implies \*(Aq\-t\*(Aq
  127. .PP
  128. At least one of \-R, \-r or \-w must be specified\&.
  129. .PP
  130. You must use \-o if you use \-d\&.
  131. .SH "EXAMPLES"
  132. .PP
  133. When
  134. gpsd
  135. is running,
  136. \fBgpspipe \-r \-n 100\fR
  137. will send one hundred raw NMEA sentences to standard output, then exit\&.
  138. .PP
  139. When
  140. gpsd
  141. is running,
  142. \fBgpspipe \-x 5 \-w|sed \-n \*(Aq/TPV/{p;q}\*(Aq\fR
  143. will wait at most 5 seconds for a TPV message, print it to stdout, then exit\&.
  144. .SH "SEE ALSO"
  145. .PP
  146. \fBgpsd\fR(8),
  147. \fBgps\fR(1),
  148. \fBlibgps\fR(3),
  149. \fBlibgpsmm\fR(3),
  150. \fBgpsprof\fR(1),
  151. \fBgpsfake\fR(1),
  152. \fBgpsctl\fR(1),
  153. \fBgpscat\fR(1)\&.
  154. \fBgpsmon\fR(1)\&.
  155. .SH "AUTHOR"
  156. .PP
  157. Gary E\&. Miller
  158. <gem@rellim\&.com>\&.