/contrib/ntp/ntpd/ntpd.1

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 296 lines · 289 code · 7 blank · 0 comment · 0 complexity · a423992d11c420eafaf7f34f253a9ca5 MD5 · raw file

  1. .TH NTPD 1 2009-12-08 "( 4.2.4p8)" "Programmer's Manual"
  2. .\" EDIT THIS FILE WITH CAUTION (ntpd.1)
  3. .\"
  4. .\" It has been AutoGen-ed Tuesday December 8, 2009 at 08:13:11 AM EST
  5. .\" From the definitions ntpd-opts.def
  6. .\" and the template file agman1.tpl
  7. .\"
  8. .SH NAME
  9. ntpd \- NTP daemon program
  10. .SH SYNOPSIS
  11. .B ntpd
  12. .\" Mixture of short (flag) options and long options
  13. .RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \--\fIopt-name\fP " [[=| ]\fIvalue\fP]]..."
  14. .PP
  15. All arguments must be options.
  16. .SH "DESCRIPTION"
  17. This manual page documents, briefly, the \fBntpd\fP command.
  18. .SH OPTIONS
  19. .TP
  20. .BR \-4 ", " \--ipv4
  21. Force IPv4 DNS name resolution.
  22. This option is a member of the ipv4 class of options.
  23. .sp
  24. Force DNS resolution of following host names on the command line
  25. to the IPv4 namespace.
  26. .TP
  27. .BR \-6 ", " \--ipv6
  28. Force IPv6 DNS name resolution.
  29. This option is a member of the ipv4 class of options.
  30. .sp
  31. Force DNS resolution of following host names on the command line
  32. to the IPv6 namespace.
  33. .TP
  34. .BR \-a ", " \--authreq
  35. Require crypto authentication.
  36. This option must not appear in combination with any of the following options:
  37. authnoreq.
  38. .sp
  39. Require cryptographic authentication for broadcast client,
  40. multicast client and symmetric passive associations.
  41. This is the default.
  42. .TP
  43. .BR \-A ", " \--authnoreq
  44. Do not require crypto authentication.
  45. This option must not appear in combination with any of the following options:
  46. authreq.
  47. .sp
  48. Do not require cryptographic authentication for broadcast client,
  49. multicast client and symmetric passive associations.
  50. This is almost never a good idea.
  51. .TP
  52. .BR \-b ", " \--bcastsync
  53. Allow us to sync to broadcast servers.
  54. .sp
  55. .TP
  56. .BR \-c " \fIstring\fP, " \--configfile "=" \fIstring\fP
  57. configuration file name.
  58. .sp
  59. The name and path of the configuration file,
  60. /etc/ntp.conf
  61. by default.
  62. .TP
  63. .BR \-d ", " \--debug-level
  64. Increase output debug message level.
  65. This option may appear an unlimited number of times.
  66. .sp
  67. Increase the debugging message output level.
  68. .TP
  69. .BR \-D " \fIstring\fP, " \--set-debug-level "=" \fIstring\fP
  70. Set the output debug message level.
  71. This option may appear an unlimited number of times.
  72. .sp
  73. Set the output debugging level. Can be supplied multiple times,
  74. but each overrides the previous value(s).
  75. .TP
  76. .BR \-f " \fIstring\fP, " \--driftfile "=" \fIstring\fP
  77. frequency drift file name.
  78. .sp
  79. The name and path of the frequency file,
  80. /etc/ntp.drift
  81. by default.
  82. This is the same operation as the
  83. driftfile driftfile
  84. configuration specification in the
  85. /etc/ntp.conf
  86. file.
  87. .TP
  88. .BR \-g ", " \--panicgate
  89. Allow the first adjustment to be Big.
  90. .sp
  91. Normally,
  92. ntpd
  93. exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that,
  94. ntpd
  95. will exit with a message to the system log. This option can be used with the
  96. -q
  97. and
  98. -x
  99. options.
  100. See the
  101. tinker
  102. configuration file directive for other options.
  103. .TP
  104. .BR \-i " \fIstring\fP, " \--jaildir "=" \fIstring\fP
  105. Jail directory.
  106. .sp
  107. Chroot the server to the directory
  108. jaildir
  109. .
  110. This option also implies that the server attempts to drop root privileges at startup (otherwise, chroot gives very little additional security), and it is only available if the OS supports to run the server without full root privileges.
  111. You may need to also specify a
  112. -u
  113. option.
  114. .TP
  115. .BR \-I " \fIiface\fP, " \--interface "=" \fIiface\fP
  116. Listen on interface.
  117. This option may appear an unlimited number of times.
  118. .sp
  119. .TP
  120. .BR \-k " \fIstring\fP, " \--keyfile "=" \fIstring\fP
  121. path to symmetric keys.
  122. .sp
  123. Specify the name and path of the symmetric key file.
  124. /etc/ntp.keys
  125. is the default.
  126. This is the same operation as the
  127. keys keyfile
  128. configuration file directive.
  129. .TP
  130. .BR \-l " \fIstring\fP, " \--logfile "=" \fIstring\fP
  131. path to the log file.
  132. .sp
  133. Specify the name and path of the log file.
  134. The default is the system log file.
  135. This is the same operation as the
  136. logfile logfile
  137. configuration file directive.
  138. .TP
  139. .BR \-L ", " \--novirtualips
  140. Do not listen to virtual IPs.
  141. .sp
  142. Do not listen to virtual IPs. The default is to listen.
  143. .TP
  144. .BR \-M ", " \--modifymmtimer
  145. Modify Multimedia Timer (Windows only).
  146. .sp
  147. Set the Windows Multimedia Timer to highest resolution.
  148. .TP
  149. .BR \-n ", " \--nofork
  150. Do not fork.
  151. .sp
  152. .TP
  153. .BR \-N ", " \--nice
  154. Run at high priority.
  155. .sp
  156. To the extent permitted by the operating system, run
  157. ntpd
  158. at the highest priority.
  159. .TP
  160. .BR \-p " \fIstring\fP, " \--pidfile "=" \fIstring\fP
  161. path to the PID file.
  162. .sp
  163. Specify the name and path of the file used to record
  164. ntpd's
  165. process ID.
  166. This is the same operation as the
  167. pidfile pidfile
  168. configuration file directive.
  169. .TP
  170. .BR \-P " \fInumber\fP, " \--priority "=" \fInumber\fP
  171. Process priority.
  172. This option takes an integer number as its argument.
  173. .sp
  174. To the extent permitted by the operating system, run
  175. ntpd
  176. at the specified
  177. sched_setscheduler(SCHED_FIFO)
  178. priority.
  179. .TP
  180. .BR \-q ", " \--quit
  181. Set the time and quit.
  182. .sp
  183. ntpd
  184. will exit just after the first time the clock is set. This behavior mimics that of the
  185. ntpdate
  186. program, which is to be retired.
  187. The
  188. -g
  189. and
  190. -x
  191. options can be used with this option.
  192. Note: The kernel time discipline is disabled with this option.
  193. .TP
  194. .BR \-r " \fIstring\fP, " \--propagationdelay "=" \fIstring\fP
  195. Broadcast/propagation delay.
  196. .sp
  197. Specify the default propagation delay from the broadcast/multicast server to this client. This is necessary only if the delay cannot be computed automatically by the protocol.
  198. .TP
  199. .BR \-U " \fInumber\fP, " \--updateinterval "=" \fInumber\fP
  200. interval in seconds between scans for new or dropped interfaces.
  201. This option takes an integer number as its argument.
  202. .sp
  203. Give the time in seconds between two scans for new or dropped interfaces.
  204. For systems with routing socket support the scans will be performed shortly after the interface change
  205. has been detected by the system.
  206. Use 0 to disable scanning.
  207. .TP
  208. .BR \-s " \fIstring\fP, " \--statsdir "=" \fIstring\fP
  209. Statistics file location.
  210. .sp
  211. Specify the directory path for files created by the statistics facility.
  212. This is the same operation as the
  213. statsdir statsdir
  214. configuration file directive.
  215. .TP
  216. .BR \-t " \fItkey\fP, " \--trustedkey "=" \fItkey\fP
  217. Trusted key number.
  218. This option may appear an unlimited number of times.
  219. .sp
  220. Add a key number to the trusted key list.
  221. .TP
  222. .BR \-u " \fIstring\fP, " \--user "=" \fIstring\fP
  223. Run as userid (or userid:groupid).
  224. .sp
  225. Specify a user, and optionally a group, to switch to.
  226. This option is only available if the OS supports to run the server without full root privileges.
  227. Currently, this option is supported under NetBSD (configure with
  228. --enable-clockctl
  229. ) and Linux (configure with
  230. --enable-linuxcaps
  231. ).
  232. .TP
  233. .BR \-v " \fInvar\fP, " \--var "=" \fInvar\fP
  234. make ARG an ntp variable (RW).
  235. This option may appear an unlimited number of times.
  236. .sp
  237. .TP
  238. .BR \-V " \fIndvar\fP, " \--dvar "=" \fIndvar\fP
  239. make ARG an ntp variable (RW|DEF).
  240. This option may appear an unlimited number of times.
  241. .sp
  242. .TP
  243. .BR \-x ", " \--slew
  244. Slew up to 600 seconds.
  245. .sp
  246. Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold.
  247. This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
  248. Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s.
  249. Thus, an adjustment as much as 600 s will take almost 14 days to complete.
  250. This option can be used with the
  251. -g
  252. and
  253. -q
  254. options.
  255. See the
  256. tinker
  257. configuration file directive for other options.
  258. Note: The kernel time discipline is disabled with this option.
  259. .TP
  260. .BR \-? , " \--help"
  261. Display usage information and exit.
  262. .TP
  263. .BR \-! , " \--more-help"
  264. Extended usage information passed thru pager.
  265. .TP
  266. .BR \-v " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
  267. Output version of program and exit. The default mode is `v', a simple
  268. version. The `c' mode will print copyright information and `n' will
  269. print the full copyright notice.
  270. .SH OPTION PRESETS
  271. Any option that is not marked as \fInot presettable\fP may be preset
  272. by loading values from environment variables named:
  273. .nf
  274. \fBNTPD_<option-name>\fP or \fBNTPD\fP
  275. .fi
  276. .aj
  277. .SH AUTHOR
  278. David L. Mills and/or others
  279. .br
  280. Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
  281. .PP
  282. .nf
  283. .na
  284. see html/copyright.html
  285. .fi
  286. .ad
  287. .PP
  288. This manual page was \fIAutoGen\fP-erated from the \fBntpd\fP
  289. option definitions.