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.
 
 
 
 
 
 

136 lines
4.4 KiB

  1. '\" t
  2. .\" Title: gpxlogger
  3. .\" Author: [see the "AUTHORS" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 05 Mar 2017
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "GPXLOGGER" "1" "05 Mar 2017" "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. gpxlogger \- Tool to connect to gpsd and generate a GPX file
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBgpxlogger\fR\ 'u
  34. \fBgpxlogger\fR [\-D\ \fIdebug\-level\fR] [\-d] [\-e\ \fIexport\-method\fR] [\-f\ \fIfilename\fR] [\-l] [\-m\ \fIminmove\fR] [\-h] [\-V] [\-i\ \fItrack\ timeout\fR] [\fIserver\fR [\fI:port\fR [\fI:device\fR]]]
  35. .SH "DESCRIPTION"
  36. .PP
  37. This program collects fixes from
  38. gpsd
  39. and logs them to standard output in GPX, an XML profile for track logging\&.
  40. .PP
  41. The output may be composed of multiple tracks\&. A new track is created if there\*(Aqs no fix written for an interval specified by the
  42. \fB\-i\fR
  43. and defaulting to 5 seconds\&.
  44. .PP
  45. gpxlogger
  46. can use any of the export methods that
  47. gpsd
  48. supports\&. For a list of these methods, use the
  49. \fB\-l\fR\&. To force the method, give the
  50. \fB\-e\fR
  51. one of the colon\-terminated method names from the
  52. \fB\-l\fR
  53. table\&.
  54. .SH "OPTIONS"
  55. .PP
  56. The
  57. \fB\-h\fR
  58. option causes
  59. gpxlogger
  60. to emit a summary of its options and then exit\&.
  61. .PP
  62. The
  63. \fB\-V\fR
  64. option causes
  65. gpxlogger
  66. to dump the package version and exit\&.
  67. .PP
  68. The
  69. \fB\-D\fR
  70. option sets a debug level; it is primarily for use by GPSD developers\&. It enables various progress messages to standard error\&.
  71. .PP
  72. The
  73. \fB\-d\fR
  74. option tells
  75. gpxlogger
  76. to run as a daemon in background\&. It requires the
  77. \fB\-f\fR
  78. option, which directs output to a specified logfile\&.
  79. .PP
  80. The
  81. \fB\-m\fR
  82. option sets a minimum move distance in meters (it may include a fractional decimal part)\&. Motions shorter than this will not be logged\&.
  83. .PP
  84. The
  85. \fB\-r\fR
  86. option tells
  87. gpxlogger
  88. to retry when GPSd loses the fix\&. Without
  89. \fB\-r\fR,
  90. gpxlogger
  91. would quit in this case\&.
  92. .PP
  93. If D\-Bus support is available on the host, GPSD is configured to use it, and
  94. \fB\-e dbus\fR
  95. is specified, this program listens to DBUS broadcasts from
  96. gpsd
  97. via org\&.gpsd\&.fix\&.
  98. .PP
  99. With
  100. \fB\-e sockets\fR, or if sockets is the method defaulted to, you may give a server\-port\-device specification as arguments\&.
  101. .PP
  102. The sockets default is to all devices on the 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. localhost:/dev/ttyS1
  105. .RS 4
  106. Look at the default port of localhost, trying both IPv4 and IPv6 and watching output from serial device 1\&.
  107. .RE
  108. .PP
  109. example\&.com:2317
  110. .RS 4
  111. Look at port 2317 on example\&.com, trying both IPv4 and IPv6\&.
  112. .RE
  113. .PP
  114. 71\&.162\&.241\&.5:2317:/dev/ttyS3
  115. .RS 4
  116. Look at port 2317 at the specified IPv4 address, collecting data from attached serial device 3\&.
  117. .RE
  118. .PP
  119. [FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:2317:/dev/ttyS5
  120. .RS 4
  121. Look at port 2317 at the specified IPv6 address, collecting data from attached serial device 5\&.
  122. .RE
  123. .SH "SEE ALSO"
  124. .PP
  125. \fBgpsd\fR(8),
  126. \fBgps\fR(1)
  127. \fBgpspipe\fR(1)
  128. .SH "AUTHORS"
  129. .PP
  130. Amaury Jacquot
  131. <sxpert@sxpert\&.org>
  132. & Petter Reinholdtsen
  133. <pere@hungry\&.com>
  134. & Chris Kuethe
  135. <chris\&.kuethe@gmail\&.com>