1 @node ntpdsim Invocation
2 @section Invoking ntpdsim
4 @cindex NTP daemon simulation program
7 # EDIT THIS FILE WITH CAUTION (ntpdsim-opts.texi)
9 # It has been AutoGen-ed Sunday August 17, 2008 at 05:20:17 AM EDT
10 # From the definitions ntpdsim-opts.def
11 # and the template file aginfo.tpl
13 This program has no explanation.
17 This section was generated by @strong{AutoGen},
18 the aginfo template and the option descriptions for the @command{ntpdsim} program. It documents the ntpdsim usage text and option meanings.
20 This software is released under a specialized copyright license.
23 * ntpdsim usage:: ntpdsim usage help (-?)
24 * ntpdsim authnoreq:: authnoreq option (-A)
25 * ntpdsim authreq:: authreq option (-a)
26 * ntpdsim bcastsync:: bcastsync option (-b)
27 * ntpdsim configfile:: configfile option (-c)
28 * ntpdsim debug-level:: debug-level option (-d)
29 * ntpdsim driftfile:: driftfile option (-f)
30 * ntpdsim dvar:: dvar option (-V)
31 * ntpdsim endsimtime:: endsimtime option (-S)
32 * ntpdsim freqerr:: freqerr option (-T)
33 * ntpdsim interface:: interface option (-I)
34 * ntpdsim ipv4:: ipv4 option (-4)
35 * ntpdsim ipv6:: ipv6 option (-6)
36 * ntpdsim jaildir:: jaildir option (-i)
37 * ntpdsim keyfile:: keyfile option (-k)
38 * ntpdsim logfile:: logfile option (-l)
39 * ntpdsim modifymmtimer:: modifymmtimer option (-M)
40 * ntpdsim ndelay:: ndelay option (-Y)
41 * ntpdsim nice:: nice option (-N)
42 * ntpdsim nofork:: nofork option (-n)
43 * ntpdsim novirtualips:: novirtualips option (-L)
44 * ntpdsim panicgate:: panicgate option (-g)
45 * ntpdsim pdelay:: pdelay option (-Z)
46 * ntpdsim phasenoise:: phasenoise option (-C)
47 * ntpdsim pidfile:: pidfile option (-p)
48 * ntpdsim priority:: priority option (-P)
49 * ntpdsim propagationdelay:: propagationdelay option (-r)
50 * ntpdsim quit:: quit option (-q)
51 * ntpdsim servertime:: servertime option (-O)
52 * ntpdsim set-debug-level:: set-debug-level option (-D)
53 * ntpdsim simbroadcastdelay:: simbroadcastdelay option (-B)
54 * ntpdsim simslew:: simslew option (-H)
55 * ntpdsim slew:: slew option (-x)
56 * ntpdsim statsdir:: statsdir option (-s)
57 * ntpdsim trustedkey:: trustedkey option (-t)
58 * ntpdsim updateinterval:: updateinterval option (-U)
59 * ntpdsim user:: user option (-u)
60 * ntpdsim var:: var option (-v)
61 * ntpdsim walknoise:: walknoise option (-W)
65 @subsection ntpdsim usage help (-?)
68 This is the automatically generated usage text for ntpdsim:
72 ntpdsim is unavailable - no --help
77 @subsection ipv4 option (-4)
80 This is the ``force ipv4 dns name resolution'' option.
82 This option has some usage constraints. It:
85 is a member of the ipv4 class of options.
88 Force DNS resolution of following host names on the command line
89 to the IPv4 namespace.
92 @subsection ipv6 option (-6)
95 This is the ``force ipv6 dns name resolution'' option.
97 This option has some usage constraints. It:
100 is a member of the ipv4 class of options.
103 Force DNS resolution of following host names on the command line
104 to the IPv6 namespace.
106 @node ntpdsim authreq
107 @subsection authreq option (-a)
108 @cindex ntpdsim-authreq
110 This is the ``require crypto authentication'' option.
112 This option has some usage constraints. It:
115 must not appear in combination with any of the following options:
119 Require cryptographic authentication for broadcast client,
120 multicast client and symmetric passive associations.
123 @node ntpdsim authnoreq
124 @subsection authnoreq option (-A)
125 @cindex ntpdsim-authnoreq
127 This is the ``do not require crypto authentication'' option.
129 This option has some usage constraints. It:
132 must not appear in combination with any of the following options:
136 Do not require cryptographic authentication for broadcast client,
137 multicast client and symmetric passive associations.
138 This is almost never a good idea.
140 @node ntpdsim bcastsync
141 @subsection bcastsync option (-b)
142 @cindex ntpdsim-bcastsync
144 This is the ``allow us to sync to broadcast servers'' option.
147 @node ntpdsim simbroadcastdelay
148 @subsection simbroadcastdelay option (-B)
149 @cindex ntpdsim-simbroadcastdelay
151 This is the ``simulator broadcast delay'' option.
154 @node ntpdsim configfile
155 @subsection configfile option (-c)
156 @cindex ntpdsim-configfile
158 This is the ``configuration file name'' option.
159 The name and path of the configuration file,
163 @node ntpdsim phasenoise
164 @subsection phasenoise option (-C)
165 @cindex ntpdsim-phasenoise
167 This is the ``phase noise level'' option.
170 @node ntpdsim debug-level
171 @subsection debug-level option (-d)
172 @cindex ntpdsim-debug-level
174 This is the ``increase output debug message level'' option.
176 This option has some usage constraints. It:
179 may appear an unlimited number of times.
181 must be compiled in by defining @code{DEBUG} during the compilation.
184 Increase the debugging message output level.
186 @node ntpdsim set-debug-level
187 @subsection set-debug-level option (-D)
188 @cindex ntpdsim-set-debug-level
190 This is the ``set the output debug message level'' option.
192 This option has some usage constraints. It:
195 may appear an unlimited number of times.
197 must be compiled in by defining @code{DEBUG} during the compilation.
200 Set the output debugging level. Can be supplied multiple times,
201 but each overrides the previous value(s).
203 @node ntpdsim driftfile
204 @subsection driftfile option (-f)
205 @cindex ntpdsim-driftfile
207 This is the ``frequency drift file name'' option.
208 The name and path of the frequency file,
211 This is the same operation as the
213 configuration specification in the
217 @node ntpdsim panicgate
218 @subsection panicgate option (-g)
219 @cindex ntpdsim-panicgate
221 This is the ``allow the first adjustment to be big'' option.
224 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,
226 will exit with a message to the system log. This option can be used with the
233 configuration file directive for other options.
235 @node ntpdsim simslew
236 @subsection simslew option (-H)
237 @cindex ntpdsim-simslew
239 This is the ``simuator slew'' option.
242 @node ntpdsim jaildir
243 @subsection jaildir option (-i)
244 @cindex ntpdsim-jaildir
246 This is the ``jail directory'' option.
247 Chroot the server to the directory
250 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.
251 You may need to also specify a
255 @node ntpdsim interface
256 @subsection interface option (-I)
257 @cindex ntpdsim-interface
259 This is the ``listen on interface'' option.
261 This option has some usage constraints. It:
264 may appear an unlimited number of times.
269 @node ntpdsim keyfile
270 @subsection keyfile option (-k)
271 @cindex ntpdsim-keyfile
273 This is the ``path to symmetric keys'' option.
274 Specify the name and path of the symmetric key file.
277 This is the same operation as the
279 configuration file directive.
281 @node ntpdsim logfile
282 @subsection logfile option (-l)
283 @cindex ntpdsim-logfile
285 This is the ``path to the log file'' option.
286 Specify the name and path of the log file.
287 The default is the system log file.
288 This is the same operation as the
290 configuration file directive.
292 @node ntpdsim novirtualips
293 @subsection novirtualips option (-L)
294 @cindex ntpdsim-novirtualips
296 This is the ``do not listen to virtual ips'' option.
297 Do not listen to virtual IPs. The default is to listen.
299 @node ntpdsim modifymmtimer
300 @subsection modifymmtimer option (-M)
301 @cindex ntpdsim-modifymmtimer
303 This is the ``modify multimedia timer (windows only)'' option.
305 This option has some usage constraints. It:
308 must be compiled in by defining @code{SYS_WINNT} during the compilation.
311 Set the Windows Multimedia Timer to highest resolution.
314 @subsection nofork option (-n)
315 @cindex ntpdsim-nofork
317 This is the ``do not fork'' option.
321 @subsection nice option (-N)
324 This is the ``run at high priority'' option.
325 To the extent permitted by the operating system, run
327 at the highest priority.
329 @node ntpdsim servertime
330 @subsection servertime option (-O)
331 @cindex ntpdsim-servertime
333 This is the ``server time'' option.
336 @node ntpdsim pidfile
337 @subsection pidfile option (-p)
338 @cindex ntpdsim-pidfile
340 This is the ``path to the pid file'' option.
341 Specify the name and path of the file used to record
344 This is the same operation as the
346 configuration file directive.
348 @node ntpdsim priority
349 @subsection priority option (-P)
350 @cindex ntpdsim-priority
352 This is the ``process priority'' option.
353 To the extent permitted by the operating system, run
356 sched_setscheduler(SCHED_FIFO)
360 @subsection quit option (-q)
363 This is the ``set the time and quit'' option.
365 will exit just after the first time the clock is set. This behavior mimics that of the
367 program, which is to be retired.
372 options can be used with this option.
373 Note: The kernel time discipline is disabled with this option.
375 @node ntpdsim propagationdelay
376 @subsection propagationdelay option (-r)
377 @cindex ntpdsim-propagationdelay
379 This is the ``broadcast/propagation delay'' option.
380 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.
382 @node ntpdsim updateinterval
383 @subsection updateinterval option (-U)
384 @cindex ntpdsim-updateinterval
386 This is the ``interval in seconds between scans for new or dropped interfaces'' option.
387 Give the time in seconds between two scans for new or dropped interfaces.
388 For systems with routing socket support the scans will be performed shortly after the interface change
389 has been detected by the system.
390 Use 0 to disable scanning.
392 @node ntpdsim statsdir
393 @subsection statsdir option (-s)
394 @cindex ntpdsim-statsdir
396 This is the ``statistics file location'' option.
397 Specify the directory path for files created by the statistics facility.
398 This is the same operation as the
400 configuration file directive.
402 @node ntpdsim endsimtime
403 @subsection endsimtime option (-S)
404 @cindex ntpdsim-endsimtime
406 This is the ``simulation end time'' option.
409 @node ntpdsim trustedkey
410 @subsection trustedkey option (-t)
411 @cindex ntpdsim-trustedkey
413 This is the ``trusted key number'' option.
415 This option has some usage constraints. It:
418 may appear an unlimited number of times.
421 Add a key number to the trusted key list.
423 @node ntpdsim freqerr
424 @subsection freqerr option (-T)
425 @cindex ntpdsim-freqerr
427 This is the ``simulation frequency error'' option.
430 @node ntpdsim walknoise
431 @subsection walknoise option (-W)
432 @cindex ntpdsim-walknoise
434 This is the ``simulation random walk noise'' option.
438 @subsection user option (-u)
441 This is the ``run as userid (or userid:groupid)'' option.
442 Specify a user, and optionally a group, to switch to.
443 This option is only available if the OS supports to run the server without full root privileges.
444 Currently, this option is supported under NetBSD (configure with
446 ) and Linux (configure with
451 @subsection var option (-v)
454 This is the ``make arg an ntp variable (rw)'' option.
456 This option has some usage constraints. It:
459 may appear an unlimited number of times.
465 @subsection dvar option (-V)
468 This is the ``make arg an ntp variable (rw|def)'' option.
470 This option has some usage constraints. It:
473 may appear an unlimited number of times.
479 @subsection slew option (-x)
482 This is the ``slew up to 600 seconds'' option.
483 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.
484 This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
485 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.
486 Thus, an adjustment as much as 600 s will take almost 14 days to complete.
487 This option can be used with the
494 configuration file directive for other options.
495 Note: The kernel time discipline is disabled with this option.
498 @subsection ndelay option (-Y)
499 @cindex ntpdsim-ndelay
501 This is the ``simulation network delay'' option.
505 @subsection pdelay option (-Z)
506 @cindex ntpdsim-pdelay
508 This is the ``simulation processing delay'' option.