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