PageRenderTime 32ms CodeModel.GetById 20ms app.highlight 4ms RepoModel.GetById 2ms app.codeStats 0ms

/contrib/ntp/ntpd/ntpdsim-opts.texi

https://bitbucket.org/freebsd/freebsd-head/
Unknown | 568 lines | 443 code | 125 blank | 0 comment | 0 complexity | d6a5d668c15a44dea2262b269162de5a MD5 | raw file
  1@node ntpdsim Invocation
  2@section Invoking ntpdsim
  3@pindex ntpdsim
  4@cindex NTP daemon simulation program
  5@ignore
  6# 
  7# EDIT THIS FILE WITH CAUTION  (ntpdsim-opts.texi)
  8# 
  9# It has been AutoGen-ed  Tuesday December  8, 2009 at 08:13:15 AM EST
 10# From the definitions    ntpdsim-opts.def
 11# and the template file   aginfo.tpl
 12@end ignore
 13This program has no explanation.
 14
 15
 16
 17This section was generated by @strong{AutoGen},
 18the aginfo template and the option descriptions for the @command{ntpdsim} program.  It documents the ntpdsim usage text and option meanings.
 19
 20This software is released under a specialized copyright license.
 21
 22@menu
 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)
 62@end menu
 63
 64@node ntpdsim usage
 65@subsection ntpdsim usage help (-?)
 66@cindex ntpdsim usage
 67
 68This is the automatically generated usage text for ntpdsim:
 69
 70@exampleindent 0
 71@example
 72ntpd - NTP daemon program - Ver. 4.2.5p247-RC
 73USAGE:  ntpdsim [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
 74  Flg Arg Option-Name    Description
 75   -4 no  ipv4           Force IPv4 DNS name resolution
 76                                - prohibits these options:
 77                                ipv6
 78   -6 no  ipv6           Force IPv6 DNS name resolution
 79                                - prohibits these options:
 80                                ipv4
 81   -a no  authreq        Require crypto authentication
 82                                - prohibits these options:
 83                                authnoreq
 84   -A no  authnoreq      Do not require crypto authentication
 85                                - prohibits these options:
 86                                authreq
 87   -b no  bcastsync      Allow us to sync to broadcast servers
 88   -c Str configfile     configuration file name
 89   -d no  debug-level    Increase output debug message level
 90                                - may appear multiple times
 91   -D Str set-debug-level Set the output debug message level
 92                                - may appear multiple times
 93   -f Str driftfile      frequency drift file name
 94   -g no  panicgate      Allow the first adjustment to be Big
 95                                - may appear multiple times
 96   -i --- jaildir        built without --enable-clockctl or --enable-linuxcaps
 97   -I Str interface      Listen on an interface name or address
 98                                - may appear multiple times
 99   -k Str keyfile        path to symmetric keys
100   -l Str logfile        path to the log file
101   -L no  novirtualips   Do not listen to virtual interfaces
102   -n no  nofork         Do not fork
103   -N no  nice           Run at high priority
104   -p Str pidfile        path to the PID file
105   -P Num priority       Process priority
106   -q no  quit           Set the time and quit
107   -r Str propagationdelay Broadcast/propagation delay
108      Str saveconfigquit Save parsed configuration and quit
109   -s Str statsdir       Statistics file location
110   -t Str trustedkey     Trusted key number
111                                - may appear multiple times
112   -u --- user           built without --enable-clockctl or --enable-linuxcaps
113   -U Num updateinterval interval in seconds between scans for new or dropped interfaces
114      Str var            make ARG an ntp variable (RW)
115                                - may appear multiple times
116      Str dvar           make ARG an ntp variable (RW|DEF)
117                                - may appear multiple times
118   -x no  slew           Slew up to 600 seconds
119      opt version        Output version information and exit
120   -? no  help           Display extended usage information and exit
121   -! no  more-help      Extended usage information passed thru pager
122
123Options are specified by doubled hyphens and their name
124or by a single hyphen and the flag character.
125
126The following option preset mechanisms are supported:
127 - examining environment variables named NTPD_*
128
129
130
131please send bug reports to:  http://bugs.ntp.org, bugs@@ntp.org
132@end example
133@exampleindent 4
134
135@node ntpdsim ipv4
136@subsection ipv4 option (-4)
137@cindex ntpdsim-ipv4
138
139This is the ``force ipv4 dns name resolution'' option.
140
141This option has some usage constraints.  It:
142@itemize @bullet
143@item
144is a member of the ipv4 class of options.
145@end itemize
146
147Force DNS resolution of following host names on the command line
148to the IPv4 namespace.
149
150@node ntpdsim ipv6
151@subsection ipv6 option (-6)
152@cindex ntpdsim-ipv6
153
154This is the ``force ipv6 dns name resolution'' option.
155
156This option has some usage constraints.  It:
157@itemize @bullet
158@item
159is a member of the ipv4 class of options.
160@end itemize
161
162Force DNS resolution of following host names on the command line
163to the IPv6 namespace.
164
165@node ntpdsim authreq
166@subsection authreq option (-a)
167@cindex ntpdsim-authreq
168
169This is the ``require crypto authentication'' option.
170
171This option has some usage constraints.  It:
172@itemize @bullet
173@item
174must not appear in combination with any of the following options:
175authnoreq.
176@end itemize
177
178Require cryptographic authentication for broadcast client,
179multicast client and symmetric passive associations.
180This is the default.
181
182@node ntpdsim authnoreq
183@subsection authnoreq option (-A)
184@cindex ntpdsim-authnoreq
185
186This is the ``do not require crypto authentication'' option.
187
188This option has some usage constraints.  It:
189@itemize @bullet
190@item
191must not appear in combination with any of the following options:
192authreq.
193@end itemize
194
195Do not require cryptographic authentication for broadcast client,
196multicast client and symmetric passive associations.
197This is almost never a good idea.
198
199@node ntpdsim bcastsync
200@subsection bcastsync option (-b)
201@cindex ntpdsim-bcastsync
202
203This is the ``allow us to sync to broadcast servers'' option.
204
205
206@node ntpdsim simbroadcastdelay
207@subsection simbroadcastdelay option (-B)
208@cindex ntpdsim-simbroadcastdelay
209
210This is the ``simulator broadcast delay'' option.
211
212
213@node ntpdsim configfile
214@subsection configfile option (-c)
215@cindex ntpdsim-configfile
216
217This is the ``configuration file name'' option.
218The name and path of the configuration file,
219/etc/ntp.conf
220by default.
221
222@node ntpdsim phasenoise
223@subsection phasenoise option (-C)
224@cindex ntpdsim-phasenoise
225
226This is the ``phase noise level'' option.
227
228
229@node ntpdsim debug-level
230@subsection debug-level option (-d)
231@cindex ntpdsim-debug-level
232
233This is the ``increase output debug message level'' option.
234
235This option has some usage constraints.  It:
236@itemize @bullet
237@item
238may appear an unlimited number of times.
239@item
240must be compiled in by defining @code{DEBUG} during the compilation.
241@end itemize
242
243Increase the debugging message output level.
244
245@node ntpdsim set-debug-level
246@subsection set-debug-level option (-D)
247@cindex ntpdsim-set-debug-level
248
249This is the ``set the output debug message level'' option.
250
251This option has some usage constraints.  It:
252@itemize @bullet
253@item
254may appear an unlimited number of times.
255@item
256must be compiled in by defining @code{DEBUG} during the compilation.
257@end itemize
258
259Set the output debugging level.  Can be supplied multiple times,
260but each overrides the previous value(s).
261
262@node ntpdsim driftfile
263@subsection driftfile option (-f)
264@cindex ntpdsim-driftfile
265
266This is the ``frequency drift file name'' option.
267The name and path of the frequency file,
268/etc/ntp.drift
269by default.
270This is the same operation as the
271driftfile driftfile
272configuration specification in the 
273/etc/ntp.conf
274file.
275
276@node ntpdsim panicgate
277@subsection panicgate option (-g)
278@cindex ntpdsim-panicgate
279
280This is the ``allow the first adjustment to be big'' option.
281Normally,
282ntpd
283exits 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,
284ntpd
285will exit with a message to the system log. This option can be used with the
286-q
287and
288-x
289options.
290See the
291tinker
292configuration file directive for other options.
293
294@node ntpdsim simslew
295@subsection simslew option (-H)
296@cindex ntpdsim-simslew
297
298This is the ``simuator slew'' option.
299
300
301@node ntpdsim jaildir
302@subsection jaildir option (-i)
303@cindex ntpdsim-jaildir
304
305This is the ``jail directory'' option.
306Chroot the server to the directory
307jaildir
308.
309This 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.
310You may need to also specify a
311-u
312option.
313
314@node ntpdsim interface
315@subsection interface option (-I)
316@cindex ntpdsim-interface
317
318This is the ``listen on interface'' option.
319
320This option has some usage constraints.  It:
321@itemize @bullet
322@item
323may appear an unlimited number of times.
324@end itemize
325
326
327
328@node ntpdsim keyfile
329@subsection keyfile option (-k)
330@cindex ntpdsim-keyfile
331
332This is the ``path to symmetric keys'' option.
333Specify the name and path of the symmetric key file.
334/etc/ntp.keys
335is the default.
336This is the same operation as the
337keys keyfile
338configuration file directive.
339
340@node ntpdsim logfile
341@subsection logfile option (-l)
342@cindex ntpdsim-logfile
343
344This is the ``path to the log file'' option.
345Specify the name and path of the log file.
346The default is the system log file.
347This is the same operation as the
348logfile logfile
349configuration file directive.
350
351@node ntpdsim novirtualips
352@subsection novirtualips option (-L)
353@cindex ntpdsim-novirtualips
354
355This is the ``do not listen to virtual ips'' option.
356Do not listen to virtual IPs. The default is to listen.
357
358@node ntpdsim modifymmtimer
359@subsection modifymmtimer option (-M)
360@cindex ntpdsim-modifymmtimer
361
362This is the ``modify multimedia timer (windows only)'' option.
363
364This option has some usage constraints.  It:
365@itemize @bullet
366@item
367must be compiled in by defining @code{SYS_WINNT} during the compilation.
368@end itemize
369
370Set the Windows Multimedia Timer to highest resolution.
371
372@node ntpdsim nofork
373@subsection nofork option (-n)
374@cindex ntpdsim-nofork
375
376This is the ``do not fork'' option.
377
378
379@node ntpdsim nice
380@subsection nice option (-N)
381@cindex ntpdsim-nice
382
383This is the ``run at high priority'' option.
384To the extent permitted by the operating system, run
385ntpd
386at the highest priority.
387
388@node ntpdsim servertime
389@subsection servertime option (-O)
390@cindex ntpdsim-servertime
391
392This is the ``server time'' option.
393
394
395@node ntpdsim pidfile
396@subsection pidfile option (-p)
397@cindex ntpdsim-pidfile
398
399This is the ``path to the pid file'' option.
400Specify the name and path of the file used to record
401ntpd's
402process ID.
403This is the same operation as the
404pidfile pidfile
405configuration file directive.
406
407@node ntpdsim priority
408@subsection priority option (-P)
409@cindex ntpdsim-priority
410
411This is the ``process priority'' option.
412To the extent permitted by the operating system, run
413ntpd
414at the specified
415sched_setscheduler(SCHED_FIFO)
416priority.
417
418@node ntpdsim quit
419@subsection quit option (-q)
420@cindex ntpdsim-quit
421
422This is the ``set the time and quit'' option.
423ntpd
424will exit just after the first time the clock is set. This behavior mimics that of the
425ntpdate
426program, which is to be retired.
427The
428-g
429and
430-x
431options can be used with this option.
432Note: The kernel time discipline is disabled with this option.
433
434@node ntpdsim propagationdelay
435@subsection propagationdelay option (-r)
436@cindex ntpdsim-propagationdelay
437
438This is the ``broadcast/propagation delay'' option.
439Specify 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.
440
441@node ntpdsim updateinterval
442@subsection updateinterval option (-U)
443@cindex ntpdsim-updateinterval
444
445This is the ``interval in seconds between scans for new or dropped interfaces'' option.
446Give the time in seconds between two scans for new or dropped interfaces.
447For systems with routing socket support the scans will be performed shortly after the interface change
448has been detected by the system.
449Use 0 to disable scanning.
450
451@node ntpdsim statsdir
452@subsection statsdir option (-s)
453@cindex ntpdsim-statsdir
454
455This is the ``statistics file location'' option.
456Specify the directory path for files created by the statistics facility.
457This is the same operation as the
458statsdir statsdir
459configuration file directive.
460
461@node ntpdsim endsimtime
462@subsection endsimtime option (-S)
463@cindex ntpdsim-endsimtime
464
465This is the ``simulation end time'' option.
466
467
468@node ntpdsim trustedkey
469@subsection trustedkey option (-t)
470@cindex ntpdsim-trustedkey
471
472This is the ``trusted key number'' option.
473
474This option has some usage constraints.  It:
475@itemize @bullet
476@item
477may appear an unlimited number of times.
478@end itemize
479
480Add a key number to the trusted key list.
481
482@node ntpdsim freqerr
483@subsection freqerr option (-T)
484@cindex ntpdsim-freqerr
485
486This is the ``simulation frequency error'' option.
487
488
489@node ntpdsim walknoise
490@subsection walknoise option (-W)
491@cindex ntpdsim-walknoise
492
493This is the ``simulation random walk noise'' option.
494
495
496@node ntpdsim user
497@subsection user option (-u)
498@cindex ntpdsim-user
499
500This is the ``run as userid (or userid:groupid)'' option.
501Specify a user, and optionally a group, to switch to.
502This option is only available if the OS supports to run the server without full root privileges.
503Currently, this option is supported under NetBSD (configure with
504--enable-clockctl
505) and Linux (configure with
506--enable-linuxcaps
507).
508
509@node ntpdsim var
510@subsection var option (-v)
511@cindex ntpdsim-var
512
513This is the ``make arg an ntp variable (rw)'' option.
514
515This option has some usage constraints.  It:
516@itemize @bullet
517@item
518may appear an unlimited number of times.
519@end itemize
520
521
522
523@node ntpdsim dvar
524@subsection dvar option (-V)
525@cindex ntpdsim-dvar
526
527This is the ``make arg an ntp variable (rw|def)'' option.
528
529This option has some usage constraints.  It:
530@itemize @bullet
531@item
532may appear an unlimited number of times.
533@end itemize
534
535
536
537@node ntpdsim slew
538@subsection slew option (-x)
539@cindex ntpdsim-slew
540
541This is the ``slew up to 600 seconds'' option.
542Normally, 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.
543This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
544Note: 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.
545Thus, an adjustment as much as 600 s will take almost 14 days to complete.
546This option can be used with the
547-g
548and
549-q
550options.
551See the
552tinker
553configuration file directive for other options.
554Note: The kernel time discipline is disabled with this option.
555
556@node ntpdsim ndelay
557@subsection ndelay option (-Y)
558@cindex ntpdsim-ndelay
559
560This is the ``simulation network delay'' option.
561
562
563@node ntpdsim pdelay
564@subsection pdelay option (-Z)
565@cindex ntpdsim-pdelay
566
567This is the ``simulation processing delay'' option.
568