1 #include autogen-version.def
5 extern int atoi(const char *);
15 descrip = "Force IPv4 DNS name resolution";
17 Force DNS resolution of following host names on the command line
18 to the IPv4 namespace.
26 descrip = "Force IPv6 DNS name resolution";
28 Force DNS resolution of following host names on the command line
29 to the IPv6 namespace.
36 descrip = "Require crypto authentication";
37 flags-cant = authnoreq;
39 Require cryptographic authentication for broadcast client,
40 multicast client and symmetric passive associations.
48 descrip = "Do not require crypto authentication";
51 Do not require cryptographic authentication for broadcast client,
52 multicast client and symmetric passive associations.
53 This is almost never a good idea.
60 descrip = "Allow us to sync to broadcast servers";
69 descrip = "configuration file name";
71 The name and path of the configuration file,
77 #include debug-opt.def
83 descrip = "frequency drift file name";
85 The name and path of the frequency file,
88 This is the same operation as the
89 @code{driftfile} @kbd{driftfile}
90 configuration specification in the
100 descrip = "Allow the first adjustment to be Big";
104 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,
106 will exit with a message to the system log. This option can be used with the
113 configuration file directive for other options.
118 name = force_step_once;
120 descrip = "Step any initial offset correction.";
124 steps the time if the time offset exceeds the step threshold,
125 which is 128 ms by default, and otherwise slews the time.
126 This option forces the initial offset correction to be stepped,
127 so the highest time accuracy can be achieved quickly.
128 However, this may also cause the time to be stepped back
129 so this option must not be used if
130 applications requiring monotonic time are running.
131 See the @code{tinker} configuration file directive for other options.
136 ifdef = HAVE_DROPROOT;
140 descrip = "Jail directory";
141 omitted-usage = "built without --enable-clockctl or --enable-linuxcaps or --enable-solarisprivs";
143 Chroot the server to the directory
146 This option also implies that the server attempts to drop root privileges at startup.
147 You may need to also specify a
150 This option is only available if the OS supports adjusting the clock
151 without full root privileges.
152 This option is supported under NetBSD (configure with
153 @code{--enable-clockctl}) or Linux (configure with
154 @code{--enable-linuxcaps}) or Solaris (configure with @code{--enable-solarisprivs}).
162 descrip = "Listen on an interface name or address";
167 Open the network address given, or all the addresses associated with the
168 given interface name. This option may appear multiple times. This option
169 also implies not opening other addresses, except wildcard and localhost.
170 This option is deprecated. Please consider using the configuration file
171 @code{interface} command, which is more versatile.
179 descrip = "path to symmetric keys";
181 Specify the name and path of the symmetric key file.
184 This is the same operation as the
185 @code{keys} @kbd{keyfile}
186 configuration file directive.
194 descrip = "path to the log file";
196 Specify the name and path of the log file.
197 The default is the system log file.
198 This is the same operation as the
199 @code{logfile} @kbd{logfile}
200 configuration file directive.
207 descrip = "Do not listen to virtual interfaces";
209 Do not listen to virtual interfaces, defined as those with
210 names containing a colon. This option is deprecated. Please
211 consider using the configuration file @code{interface} command, which
218 name = modifymmtimer;
220 descrip = "Modify Multimedia Timer (Windows only)";
222 Set the Windows Multimedia Timer to highest resolution. This
223 ensures the resolution does not change while ntpd is running,
224 avoiding timekeeping glitches associated with changes.
231 flags-cant = wait-sync;
232 descrip = "Do not fork";
240 descrip = "Run at high priority";
242 To the extent permitted by the operating system, run
244 at the highest priority.
252 descrip = "path to the PID file";
254 Specify the name and path of the file used to record
257 This is the same operation as the
258 @code{pidfile} @kbd{pidfile}
259 configuration file directive.
267 descrip = "Process priority";
269 To the extent permitted by the operating system, run
272 @code{sched_setscheduler(SCHED_FIFO)}
280 flags-cant = saveconfigquit;
281 flags-cant = wait-sync;
282 descrip = "Set the time and quit";
285 will not daemonize and will exit after the clock is first
286 synchronized. This behavior mimics that of the
288 program, which will soon be replaced with a shell script.
293 options can be used with this option.
294 Note: The kernel time discipline is disabled with this option.
299 name = propagationdelay;
302 descrip = "Broadcast/propagation delay";
304 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.
310 name = saveconfigquit;
313 flags-cant = wait-sync;
314 descrip = "Save parsed configuration and quit";
316 Cause @code{ntpd} to parse its startup configuration file and save an
317 equivalent to the given filename and exit. This option was
318 designed for automated testing.
326 descrip = "Statistics file location";
328 Specify the directory path for files created by the statistics facility.
329 This is the same operation as the
330 @code{statsdir} @kbd{statsdir}
331 configuration file directive.
339 descrip = "Trusted key number";
344 Add the specified key number to the trusted key list.
349 ifdef = HAVE_DROPROOT;
353 descrip = "Run as userid (or userid:groupid)";
354 omitted-usage = "built without --enable-clockctl or --enable-linuxcaps or --enable-solarisprivs";
356 Specify a user, and optionally a group, to switch to.
357 This option is only available if the OS supports adjusting the clock
358 without full root privileges.
359 This option is supported under NetBSD (configure with
360 @code{--enable-clockctl}) or Linux (configure with
361 @code{--enable-linuxcaps}) or Solaris (configure with @code{--enable-solarisprivs}).
366 name = updateinterval;
369 descrip = "interval in seconds between scans for new or dropped interfaces";
371 Give the time in seconds between two scans for new or dropped interfaces.
372 For systems with routing socket support the scans will be performed shortly after the interface change
373 has been detected by the system.
374 Use 0 to disable scanning. 60 seconds is the minimum time between scans.
380 /* value = v; Bug 817 */
382 descrip = "make ARG an ntp variable (RW)";
392 /* value = V; Bug 817 */
394 descrip = "make ARG an ntp variable (RW|DEF)";
403 ifdef = HAVE_WORKING_FORK;
409 flags-cant = saveconfigquit;
410 descrip = "Seconds to wait for first clock sync";
412 If greater than zero, alters @code{ntpd}'s behavior when forking to
413 daemonize. Instead of exiting with status 0 immediately after
414 the fork, the parent waits up to the specified number of
415 seconds for the child to first synchronize the clock. The exit
416 status is zero (success) if the clock was synchronized,
417 otherwise it is @code{ETIMEDOUT}.
418 This provides the option for a script starting @code{ntpd} to easily
419 wait for the first set of the clock before proceeding.
422 ** XXX: is it "first set" or is it more? If it's only "first set" then
423 ** that's not the same as SYNC.
430 descrip = "Slew up to 600 seconds";
432 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.
433 This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
434 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.
435 Thus, an adjustment as much as 600 s will take almost 14 days to complete.
436 This option can be used with the
443 configuration file directive for other options.
444 Note: The kernel time discipline is disabled with this option.
451 descrip = "Use CPU cycle counter (Windows only)";
453 Attempt to substitute the CPU counter for @code{QueryPerformanceCounter}.
454 The CPU counter and @code{QueryPerformanceCounter} are compared, and if
455 they have the same frequency, the CPU counter (RDTSC on x86) is
456 used directly, saving the overhead of a system call.
464 descrip = "Force CPU cycle counter use (Windows only)";
466 Force substitution the CPU counter for @code{QueryPerformanceCounter}.
467 The CPU counter (RDTSC on x86) is used unconditionally with the
468 given frequency (in Hz).
473 ifdef = HAVE_DNSREGISTRATION;
476 descrip = "Register with mDNS as a NTP server";
478 Registers as an NTP server with the local mDNS server which allows
479 the server to be discovered via mDNS client lookup.