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.
 
 
 
 
 
 

73 lines
2.6 KiB

  1. '\" t
  2. .\" Title: gpsdctl
  3. .\" Author: [see the "AUTHOR" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 25 Jun 2011
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "GPSDCTL" "8" "25 Jun 2011" "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. gpsdctl \- tool for sending commands to gpsd over its control socket
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBgpdsctl\fR\ 'u
  34. \fBgpdsctl\fR \fIaction\fR \fIdevice\fR
  35. .SH "DESCRIPTION"
  36. .PP
  37. This is a tool for sending an instance of
  38. gpsd
  39. commands over its control socket to add or remove devices from the daemon\*(Aqs device list\&. It is not intended to be called by users, but rather by the Linux hotplug system and similar facilities\&.
  40. .PP
  41. The action argument may be "add" or "remove"\&. If no daemon instance is running when an add is requested, this program will launch one\&.
  42. .PP
  43. The "device" argument should be the pathname of a device\&. A device on the list will be opened to read sensor data whenever a client requests a watch\&.
  44. .PP
  45. Two environment variables are interpreted\&.
  46. \fBGPSD_SOCKET\fR
  47. sets the location of the control socket\&. It defaults to
  48. /var/run/gpsd\&.sock
  49. if the effective user ID of this program is root,
  50. /tmp/gpsd\&.sock
  51. otherwise\&.
  52. .PP
  53. \fBGPSD_OPTIONS\fR
  54. may be a list of options to be passed to
  55. gpsd
  56. when this tool launches it\&. It defaults to an empty string\&.
  57. .SH "RETURN VALUES"
  58. .PP
  59. 1 if the action was unknown or the write to the control socket failed, 0 otherwise
  60. .SH "SEE ALSO"
  61. .PP
  62. \fBgpsd\fR(8),
  63. \fBgpsctl\fR(1),
  64. \fBgps\fR(1),
  65. \fBlibgps\fR(3),
  66. \fBlibgpsmm\fR(3),
  67. \fBgpsprof\fR(1),
  68. \fBgpsfake\fR(1)\&.
  69. .SH "AUTHOR"
  70. .PP
  71. Eric S\&. Raymond
  72. <esr@thyrsus\&.com>\&.