1
@node ntpdsim Invocation
2
@section Invoking ntpdsim
4
@cindex NTP daemon simulation program
6
# -*- buffer-read-only: t -*- vi: set ro:
8
# DO NOT EDIT THIS FILE (ntpdsim-opts.texi)
10
# It has been AutoGen-ed Monday September 10, 2007 at 08:31:24 PM EDT
11
# From the definitions ntpdsim-opts.def
12
# and the template file aginfo.tpl
14
This program has no explanation.
18
This section was generated by @strong{AutoGen},
19
the aginfo template and the option descriptions for the @command{ntpdsim} program. It documents the ntpdsim usage text and option meanings.
21
This software is released under a specialized copyright license.
24
* ntpdsim usage:: ntpdsim usage help (-?)
25
* ntpdsim authnoreq:: authnoreq option (-A)
26
* ntpdsim authreq:: authreq option (-a)
27
* ntpdsim bcastsync:: bcastsync option (-b)
28
* ntpdsim configfile:: configfile option (-c)
29
* ntpdsim debug-level:: debug-level option (-d)
30
* ntpdsim driftfile:: driftfile option (-f)
31
* ntpdsim dvar:: dvar option (-V)
32
* ntpdsim endsimtime:: endsimtime option (-S)
33
* ntpdsim freqerr:: freqerr option (-T)
34
* ntpdsim interface:: interface option (-I)
35
* ntpdsim ipv4:: ipv4 option (-4)
36
* ntpdsim ipv6:: ipv6 option (-6)
37
* ntpdsim jaildir:: jaildir option (-i)
38
* ntpdsim keyfile:: keyfile option (-k)
39
* ntpdsim logfile:: logfile option (-l)
40
* ntpdsim modifymmtimer:: modifymmtimer option (-M)
41
* ntpdsim ndelay:: ndelay option (-Y)
42
* ntpdsim nice:: nice option (-N)
43
* ntpdsim nofork:: nofork option (-n)
44
* ntpdsim novirtualips:: novirtualips option (-L)
45
* ntpdsim panicgate:: panicgate option (-g)
46
* ntpdsim pdelay:: pdelay option (-Z)
47
* ntpdsim phasenoise:: phasenoise option (-C)
48
* ntpdsim pidfile:: pidfile option (-p)
49
* ntpdsim priority:: priority option (-P)
50
* ntpdsim propagationdelay:: propagationdelay option (-r)
51
* ntpdsim quit:: quit option (-q)
52
* ntpdsim servertime:: servertime option (-O)
53
* ntpdsim set-debug-level:: set-debug-level option (-D)
54
* ntpdsim simbroadcastdelay:: simbroadcastdelay option (-B)
55
* ntpdsim simslew:: simslew option (-H)
56
* ntpdsim slew:: slew option (-x)
57
* ntpdsim statsdir:: statsdir option (-s)
58
* ntpdsim trustedkey:: trustedkey option (-t)
59
* ntpdsim updateinterval:: updateinterval option (-U)
60
* ntpdsim user:: user option (-u)
61
* ntpdsim var:: var option (-v)
62
* ntpdsim walknoise:: walknoise option (-W)
66
@subsection ntpdsim usage help (-?)
69
This is the automatically generated usage text for ntpdsim:
73
ntpdsim is unavailable - no --help
78
@subsection ipv4 option (-4)
81
This is the ``force ipv4 dns name resolution'' option.
83
This option has some usage constraints. It:
86
is a member of the ipv4 class of options.
89
Force DNS resolution of following host names on the command line
90
to the IPv4 namespace.
93
@subsection ipv6 option (-6)
96
This is the ``force ipv6 dns name resolution'' option.
98
This option has some usage constraints. It:
101
is a member of the ipv4 class of options.
104
Force DNS resolution of following host names on the command line
105
to the IPv6 namespace.
107
@node ntpdsim authreq
108
@subsection authreq option (-a)
109
@cindex ntpdsim-authreq
111
This is the ``require crypto authentication'' option.
113
This option has some usage constraints. It:
116
must not appear in combination with any of the following options:
120
Require cryptographic authentication for broadcast client,
121
multicast client and symmetric passive associations.
124
@node ntpdsim authnoreq
125
@subsection authnoreq option (-A)
126
@cindex ntpdsim-authnoreq
128
This is the ``do not require crypto authentication'' option.
130
This option has some usage constraints. It:
133
must not appear in combination with any of the following options:
137
Do not require cryptographic authentication for broadcast client,
138
multicast client and symmetric passive associations.
139
This is almost never a good idea.
141
@node ntpdsim bcastsync
142
@subsection bcastsync option (-b)
143
@cindex ntpdsim-bcastsync
145
This is the ``allow us to sync to broadcast servers'' option.
148
@node ntpdsim simbroadcastdelay
149
@subsection simbroadcastdelay option (-B)
150
@cindex ntpdsim-simbroadcastdelay
152
This is the ``simulator broadcast delay'' option.
155
@node ntpdsim configfile
156
@subsection configfile option (-c)
157
@cindex ntpdsim-configfile
159
This is the ``configuration file name'' option.
160
The name and path of the configuration file,
164
@node ntpdsim phasenoise
165
@subsection phasenoise option (-C)
166
@cindex ntpdsim-phasenoise
168
This is the ``phase noise level'' option.
171
@node ntpdsim debug-level
172
@subsection debug-level option (-d)
173
@cindex ntpdsim-debug-level
175
This is the ``increase output debug message level'' option.
177
This option has some usage constraints. It:
180
may appear an unlimited number of times.
182
must be compiled in by defining @code{DEBUG} during the compilation.
185
Increase the debugging message output level.
187
@node ntpdsim set-debug-level
188
@subsection set-debug-level option (-D)
189
@cindex ntpdsim-set-debug-level
191
This is the ``set the output debug message level'' option.
193
This option has some usage constraints. It:
196
may appear an unlimited number of times.
198
must be compiled in by defining @code{DEBUG} during the compilation.
201
Set the output debugging level. Can be supplied multiple times,
202
but each overrides the previous value(s).
204
@node ntpdsim driftfile
205
@subsection driftfile option (-f)
206
@cindex ntpdsim-driftfile
208
This is the ``frequency drift file name'' option.
209
The name and path of the frequency file,
212
This is the same operation as the
214
configuration specification in the
218
@node ntpdsim panicgate
219
@subsection panicgate option (-g)
220
@cindex ntpdsim-panicgate
222
This is the ``allow the first adjustment to be big'' option.
225
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,
227
will exit with a message to the system log. This option can be used with the
234
configuration file directive for other options.
236
@node ntpdsim simslew
237
@subsection simslew option (-H)
238
@cindex ntpdsim-simslew
240
This is the ``simuator slew'' option.
243
@node ntpdsim jaildir
244
@subsection jaildir option (-i)
245
@cindex ntpdsim-jaildir
247
This is the ``jail directory'' option.
248
Chroot the server to the directory
251
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.
252
You may need to also specify a
256
@node ntpdsim interface
257
@subsection interface option (-I)
258
@cindex ntpdsim-interface
260
This is the ``listen on interface'' option.
262
This option has some usage constraints. It:
265
may appear an unlimited number of times.
270
@node ntpdsim keyfile
271
@subsection keyfile option (-k)
272
@cindex ntpdsim-keyfile
274
This is the ``path to symmetric keys'' option.
275
Specify the name and path of the symmetric key file.
278
This is the same operation as the
280
configuration file directive.
282
@node ntpdsim logfile
283
@subsection logfile option (-l)
284
@cindex ntpdsim-logfile
286
This is the ``path to the log file'' option.
287
Specify the name and path of the log file.
288
The default is the system log file.
289
This is the same operation as the
291
configuration file directive.
293
@node ntpdsim novirtualips
294
@subsection novirtualips option (-L)
295
@cindex ntpdsim-novirtualips
297
This is the ``do not listen to virtual ips'' option.
298
Do not listen to virtual IPs. The default is to listen.
300
@node ntpdsim modifymmtimer
301
@subsection modifymmtimer option (-M)
302
@cindex ntpdsim-modifymmtimer
304
This is the ``modify multimedia timer (windows only)'' option.
306
This option has some usage constraints. It:
309
must be compiled in by defining @code{SYS_WINNT} during the compilation.
312
Set the Windows Multimedia Timer to highest resolution.
315
@subsection nofork option (-n)
316
@cindex ntpdsim-nofork
318
This is the ``do not fork'' option.
322
@subsection nice option (-N)
325
This is the ``run at high priority'' option.
326
To the extent permitted by the operating system, run
328
at the highest priority.
330
@node ntpdsim servertime
331
@subsection servertime option (-O)
332
@cindex ntpdsim-servertime
334
This is the ``server time'' option.
337
@node ntpdsim pidfile
338
@subsection pidfile option (-p)
339
@cindex ntpdsim-pidfile
341
This is the ``path to the pid file'' option.
342
Specify the name and path of the file used to record
345
This is the same operation as the
347
configuration file directive.
349
@node ntpdsim priority
350
@subsection priority option (-P)
351
@cindex ntpdsim-priority
353
This is the ``process priority'' option.
354
To the extent permitted by the operating system, run
357
sched_setscheduler(SCHED_FIFO)
361
@subsection quit option (-q)
364
This is the ``set the time and quit'' option.
366
will exit just after the first time the clock is set. This behavior mimics that of the
368
program, which is to be retired.
373
options can be used with this option.
374
Note: The kernel time discipline is disabled with this option.
376
@node ntpdsim propagationdelay
377
@subsection propagationdelay option (-r)
378
@cindex ntpdsim-propagationdelay
380
This is the ``broadcast/propagation delay'' option.
381
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.
383
@node ntpdsim updateinterval
384
@subsection updateinterval option (-U)
385
@cindex ntpdsim-updateinterval
387
This is the ``interval in seconds between scans for new or dropped interfaces'' option.
388
Give the time in seconds between two scans for new or dropped interfaces.
389
For systems with routing socket support the scans will be performed shortly after the interface change
390
has been detected by the system.
391
Use 0 to disable scanning. 60 seconds is the minimum time between scans.
393
@node ntpdsim statsdir
394
@subsection statsdir option (-s)
395
@cindex ntpdsim-statsdir
397
This is the ``statistics file location'' option.
398
Specify the directory path for files created by the statistics facility.
399
This is the same operation as the
401
configuration file directive.
403
@node ntpdsim endsimtime
404
@subsection endsimtime option (-S)
405
@cindex ntpdsim-endsimtime
407
This is the ``simulation end time'' option.
410
@node ntpdsim trustedkey
411
@subsection trustedkey option (-t)
412
@cindex ntpdsim-trustedkey
414
This is the ``trusted key number'' option.
416
This option has some usage constraints. It:
419
may appear an unlimited number of times.
422
Add a key number to the trusted key list.
424
@node ntpdsim freqerr
425
@subsection freqerr option (-T)
426
@cindex ntpdsim-freqerr
428
This is the ``simulation frequency error'' option.
431
@node ntpdsim walknoise
432
@subsection walknoise option (-W)
433
@cindex ntpdsim-walknoise
435
This is the ``simulation random walk noise'' option.
439
@subsection user option (-u)
442
This is the ``run as userid (or userid:groupid)'' option.
443
Specify a user, and optionally a group, to switch to.
444
This option is only available if the OS supports to run the server without full root privileges.
445
Currently, this option is supported under NetBSD (configure with
447
) and Linux (configure with
452
@subsection var option (-v)
455
This is the ``make arg an ntp variable (rw)'' option.
457
This option has some usage constraints. It:
460
may appear an unlimited number of times.
466
@subsection dvar option (-V)
469
This is the ``make arg an ntp variable (rw|def)'' option.
471
This option has some usage constraints. It:
474
may appear an unlimited number of times.
480
@subsection slew option (-x)
483
This is the ``slew up to 600 seconds'' option.
484
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.
485
This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
486
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.
487
Thus, an adjustment as much as 600 s will take almost 14 days to complete.
488
This option can be used with the
495
configuration file directive for other options.
496
Note: The kernel time discipline is disabled with this option.
499
@subsection ndelay option (-Y)
500
@cindex ntpdsim-ndelay
502
This is the ``simulation network delay'' option.
506
@subsection pdelay option (-Z)
507
@cindex ntpdsim-pdelay
509
This is the ``simulation processing delay'' option.
added
removed
ntpd/ntpdsim-opts.texi
