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.
 
 
 
 
 
 

103 lines
3.3 KiB

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!--
  3. This file is Copyright 2010 by the GPSD project
  4. SPDX-License-Identifier: BSD-2-clause
  5. -->
  6. <!DOCTYPE refentry PUBLIC
  7. "-//OASIS//DTD DocBook XML V4.1.2//EN"
  8. "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
  9. <refentry id='gpsdctl.8'>
  10. <refentryinfo>
  11. <date>6 December 2020</date>
  12. </refentryinfo>
  13. <refmeta>
  14. <refentrytitle>gpsdctl</refentrytitle>
  15. <manvolnum>8</manvolnum>
  16. <refmiscinfo class="source">The GPSD Project</refmiscinfo>
  17. <refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
  18. </refmeta>
  19. <refnamediv id='name'>
  20. <refname>gpsdctl</refname>
  21. <refpurpose>tool for sending commands to gpsd over its control socket</refpurpose>
  22. </refnamediv>
  23. <refsynopsisdiv id='synopsis'>
  24. <cmdsynopsis>
  25. <command>gpdsctl</command>
  26. <arg choice='plain'>
  27. <replaceable>action</replaceable>
  28. </arg>
  29. <arg choice='plain'>
  30. <replaceable>device</replaceable>
  31. </arg>
  32. </cmdsynopsis>
  33. </refsynopsisdiv>
  34. <refsect1 id='description'>
  35. <title>DESCRIPTION</title>
  36. <para>This is a tool for sending an instance of
  37. <application>gpsd</application> commands over its control socket to
  38. add or remove devices from the daemon's device list. It is not
  39. intended to be called by users, but rather by the Linux hotplug
  40. system and similar facilities.</para>
  41. <para>The action argument may be "<option>add</option>" or "<option>remove</option>". If no daemon
  42. instance is running when an add is requested, this program will launch
  43. one.</para>
  44. <para>The "device" argument should be the pathname of a device. A
  45. device on the list will be opened to read sensor data whenever a
  46. client requests a watch.</para>
  47. <para>Two environment variables are interpreted.</para>
  48. <para>
  49. <envar>GPSD_SOCKET</envar> sets the location
  50. of the control socket. If the effective user ID of
  51. this program is root then it usually defaults to
  52. <filename>/run/gpsd.sock</filename>, although some systems may use the
  53. deprecated <filename>/var/run/gpsd.sock</filename> instead. Non-root
  54. users will use <filename>/tmp/gpsd.sock</filename>.</para>
  55. <para>
  56. <envar>GPSD_OPTIONS</envar>
  57. may be a list of options to be passed to <application>gpsd</application>
  58. when this tool launches it. It defaults to an empty string.</para>
  59. </refsect1>
  60. <refsect1 id='exit_status'>
  61. <title>RETURN VALUES</title>
  62. <para>1 if the action was unknown or the write to the control socket
  63. failed, 0 otherwise</para>
  64. </refsect1>
  65. <refsect1 id='see_also'>
  66. <title>SEE ALSO</title>
  67. <para>
  68. <citerefentry>
  69. <refentrytitle>gpsd</refentrytitle>
  70. <manvolnum>8</manvolnum>
  71. </citerefentry>,
  72. <citerefentry>
  73. <refentrytitle>gpsctl</refentrytitle>
  74. <manvolnum>1</manvolnum>
  75. </citerefentry>,
  76. <citerefentry>
  77. <refentrytitle>gps</refentrytitle>
  78. <manvolnum>1</manvolnum>
  79. </citerefentry>,
  80. <citerefentry>
  81. <refentrytitle>libgps</refentrytitle>
  82. <manvolnum>3</manvolnum>
  83. </citerefentry>,
  84. <citerefentry>
  85. <refentrytitle>libgpsmm</refentrytitle>
  86. <manvolnum>3</manvolnum>
  87. </citerefentry>,
  88. <citerefentry>
  89. <refentrytitle>gpsprof</refentrytitle>
  90. <manvolnum>1</manvolnum>
  91. </citerefentry>,
  92. <citerefentry>
  93. <refentrytitle>gpsfake</refentrytitle>
  94. <manvolnum>1</manvolnum>
  95. </citerefentry>.
  96. </para>
  97. </refsect1>
  98. <refsect1 id='maintainer'>
  99. <title>AUTHOR</title>
  100. <para>Eric S. Raymond <email>esr@thyrsus.com</email>.</para>
  101. </refsect1>
  102. </refentry>