Source code pulled from OpenBSD for OpenNTPD. The place to contribute to this code is via the OpenBSD CVS tree.
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.

79 lines
2.5 KiB

11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
  1. .\" $OpenBSD: ntpctl.8,v 1.8 2015/03/11 19:38:48 jmc Exp $
  2. .\"
  3. .\" Copyright (c) 2012 Mike Miller <mmiller@mgm51.com>
  4. .\"
  5. .\" Permission to use, copy, modify, and distribute this software for any
  6. .\" purpose with or without fee is hereby granted, provided that the above
  7. .\" copyright notice and this permission notice appear in all copies.
  8. .\"
  9. .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10. .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11. .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12. .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13. .\" WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN
  14. .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  15. .\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16. .\"
  17. .Dd $Mdocdate: March 11 2015 $
  18. .Dt NTPCTL 8
  19. .Os
  20. .Sh NAME
  21. .Nm ntpctl
  22. .Nd control the Network Time Protocol daemon
  23. .Sh SYNOPSIS
  24. .Nm ntpctl
  25. .Fl s Cm all | peers | Sensors | status
  26. .Sh DESCRIPTION
  27. The
  28. .Nm
  29. program displays information about the running
  30. .Xr ntpd 8
  31. daemon.
  32. .Pp
  33. The options are as follows:
  34. .Bl -tag -width "-s modifierX"
  35. .It Fl s Cm all | peers | Sensors | status
  36. Used to display information about the running daemon.
  37. Keywords may be abbreviated.
  38. .Pp
  39. .Cm all
  40. shows all data available.
  41. .Pp
  42. .Cm peers
  43. shows the following information about each peer: weight, trustlevel,
  44. stratum, number of seconds until the next poll, polling interval
  45. in seconds, and offset, network delay and network jitter in milliseconds.
  46. When the system clock is synced to a peer, an asterisk
  47. is displayed to the left of the weight column for that peer.
  48. .Pp
  49. .Cm Sensors
  50. shows the following information about each sensor: weight, sensor "good"
  51. status, stratum, and offset and the configured correction in
  52. milliseconds.
  53. When the system clock is synced to a sensor, an asterisk
  54. is displayed to the left of the weight column for that sensor.
  55. .Pp
  56. .Cm status
  57. shows the status of peers and sensors, and whether the system clock is synced.
  58. When the system clock is synced, the stratum is displayed.
  59. When the system clock is not synced, the offset of the system clock,
  60. as reported by the
  61. .Xr adjtime 2
  62. system call, is displayed.
  63. When the median constraint is set, the offset to the local time is displayed.
  64. .El
  65. .Sh FILES
  66. .Bl -tag -width "/var/run/ntpd.sockXXX" -compact
  67. .It Pa /var/run/ntpd.sock
  68. Socket file for communication with
  69. .Xr ntpd 8 .
  70. .El
  71. .Sh SEE ALSO
  72. .Xr adjtime 2 ,
  73. .Xr ntpd.conf 5 ,
  74. .Xr ntpd 8
  75. .Sh HISTORY
  76. The
  77. .Nm
  78. program first appeared in
  79. .Ox 5.5 .