Annotation of embedaddon/ntp/ntpd/ntpdbase-opts.def, revision 1.1.1.1
1.1 misho 1: #include autogen-version.def
2:
3: include = <<- _EOF_
4: #ifdef __windows
5: extern int atoi(const char *);
6: #else
7: # include <stdlib.h>
8: #endif
9: _EOF_;
10:
11: test-main;
12:
13: flag = {
14: name = ipv4;
15: value = 4;
16: flags-cant = ipv6;
17: descrip = "Force IPv4 DNS name resolution";
18: doc = <<- _EndOfDoc_
19: Force DNS resolution of following host names on the command line
20: to the IPv4 namespace.
21: _EndOfDoc_;
22: };
23:
24: flag = {
25: name = ipv6;
26: value = 6;
27: flags-cant = ipv4;
28: descrip = "Force IPv6 DNS name resolution";
29: doc = <<- _EndOfDoc_
30: Force DNS resolution of following host names on the command line
31: to the IPv6 namespace.
32: _EndOfDoc_;
33: };
34:
35: flag = {
36: name = authreq;
37: value = a;
38: descrip = "Require crypto authentication";
39: flags-cant = authnoreq;
40: doc = <<- _EndOfDoc_
41: Require cryptographic authentication for broadcast client,
42: multicast client and symmetric passive associations.
43: This is the default.
44: _EndOfDoc_;
45: };
46:
47: flag = {
48: name = authnoreq;
49: value = A;
50: descrip = "Do not require crypto authentication";
51: flags-cant = authreq;
52: doc = <<- _EndOfDoc_
53: Do not require cryptographic authentication for broadcast client,
54: multicast client and symmetric passive associations.
55: This is almost never a good idea.
56: _EndOfDoc_;
57: };
58:
59: flag = {
60: name = bcastsync;
61: value = b;
62: descrip = "Allow us to sync to broadcast servers";
63: doc = <<- _EndOfDoc_
64: _EndOfDoc_;
65: };
66:
67: flag = {
68: name = configfile;
69: value = c;
70: arg-type = string;
71: descrip = "configuration file name";
72: doc = <<- _EndOfDoc_
73: The name and path of the configuration file,
74: /etc/ntp.conf
75: by default.
76: _EndOfDoc_;
77: };
78:
79: flag = {
80: name = debug-level;
81: value = d;
82: max = NOLIMIT;
83: ifdef = DEBUG;
84: nopreset;
85: descrip = "Increase output debug message level";
86: omitted-usage = "this package was built using 'configure --disable--debug'";
87: doc = <<- _EndOfDoc_
88: Increase the debugging message output level.
89: _EndOfDoc_;
90: };
91:
92: flag = {
93: name = set-debug-level;
94: value = D;
95: arg-type = string;
96: max = NOLIMIT;
97: ifdef = DEBUG;
98: descrip = "Set the output debug message level";
99: omitted-usage = "this package was built using 'configure --disable--debug'";
100: flag-code = 'DESC(DEBUG_LEVEL).optOccCt = atoi( pOptDesc->pzLastArg );';
101: doc = <<- _EndOfDoc_
102: Set the output debugging level. Can be supplied multiple times,
103: but each overrides the previous value(s).
104: _EndOfDoc_;
105: };
106:
107: flag = {
108: name = driftfile;
109: value = f;
110: arg-type = string;
111: descrip = "frequency drift file name";
112: doc = <<- _EndOfDoc_
113: The name and path of the frequency file,
114: /etc/ntp.drift
115: by default.
116: This is the same operation as the
117: driftfile driftfile
118: configuration specification in the
119: /etc/ntp.conf
120: file.
121: _EndOfDoc_;
122: };
123:
124: flag = {
125: name = panicgate;
126: value = g;
127: max = NOLIMIT;
128: descrip = "Allow the first adjustment to be Big";
129: doc = <<- _EndOfDoc_
130: Normally,
131: ntpd
132: 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,
133: ntpd
134: will exit with a message to the system log. This option can be used with the
135: -q
136: and
137: -x
138: options.
139: See the
140: tinker
141: configuration file directive for other options.
142: _EndOfDoc_;
143: };
144:
145: flag = {
146: ifdef = HAVE_DROPROOT;
147: name = jaildir;
148: value = i;
149: arg-type = string;
150: descrip = "Jail directory";
151: omitted-usage = "built without --enable-clockctl or --enable-linuxcaps";
152: doc = <<- _EndOfDoc_
153: Chroot the server to the directory
154: jaildir
155: .
156: This option also implies that the server attempts to drop root privileges at startup.
157: You may need to also specify a
158: -u
159: option.
160: This option is only available if the OS supports adjusting the clock
161: without full root privileges.
162: This option is supported under NetBSD (configure with
163: --enable-clockctl
164: ) and Linux (configure with
165: --enable-linuxcaps
166: ).
167: _EndOfDoc_;
168: };
169:
170: flag = {
171: name = interface;
172: value = I;
173: arg-type = string;
174: descrip = "Listen on an interface name or address";
175: max = NOLIMIT;
176: arg-name = iface;
177: stack-arg;
178: doc = <<- _EndOfDoc_
179: Open the network address given, or all the addresses associated with the
180: given interface name. This option may appear multiple times. This option
181: also implies not opening other addresses, except wildcard and localhost.
182: This option is deprecated. Please consider using the configuration file
183: interface command, which is more versatile.
184: _EndOfDoc_;
185: };
186:
187: flag = {
188: name = keyfile;
189: value = k;
190: arg-type = string;
191: descrip = "path to symmetric keys";
192: doc = <<- _EndOfDoc_
193: Specify the name and path of the symmetric key file.
194: /etc/ntp.keys
195: is the default.
196: This is the same operation as the
197: keys keyfile
198: configuration file directive.
199: _EndOfDoc_;
200: };
201:
202: flag = {
203: name = logfile;
204: value = l;
205: arg-type = string;
206: descrip = "path to the log file";
207: doc = <<- _EndOfDoc_
208: Specify the name and path of the log file.
209: The default is the system log file.
210: This is the same operation as the
211: logfile logfile
212: configuration file directive.
213: _EndOfDoc_;
214: };
215:
216: flag = {
217: name = novirtualips;
218: value = L;
219: descrip = "Do not listen to virtual interfaces";
220: doc = <<- _EndOfDoc_
221: Do not listen to virtual interfaces, defined as those with
222: names containing a colon. This option is deprecated. Please
223: consider using the configuration file interface command, which
224: is more versatile.
225: _EndOfDoc_;
226: };
227:
228: flag = {
229: ifdef = SYS_WINNT;
230: name = modifymmtimer;
231: value = M;
232: descrip = "Modify Multimedia Timer (Windows only)";
233: doc = <<- _EndOfDoc_
234: Set the Windows Multimedia Timer to highest resolution. This
235: ensures the resolution does not change while ntpd is running,
236: avoiding timekeeping glitches associated with changes.
237: _EndOfDoc_;
238: };
239:
240: flag = {
241: name = nofork;
242: value = n;
243: descrip = "Do not fork";
244: doc = <<- _EndOfDoc_
245: _EndOfDoc_;
246: };
247:
248: flag = {
249: name = nice;
250: value = N;
251: descrip = "Run at high priority";
252: doc = <<- _EndOfDoc_
253: To the extent permitted by the operating system, run
254: ntpd
255: at the highest priority.
256: _EndOfDoc_;
257: };
258:
259: flag = {
260: name = pidfile;
261: value = p;
262: arg-type = string;
263: descrip = "path to the PID file";
264: doc = <<- _EndOfDoc_
265: Specify the name and path of the file used to record
266: ntpd's
267: process ID.
268: This is the same operation as the
269: pidfile pidfile
270: configuration file directive.
271: _EndOfDoc_;
272: };
273:
274: flag = {
275: name = priority;
276: value = P;
277: arg-type = number;
278: descrip = "Process priority";
279: doc = <<- _EndOfDoc_
280: To the extent permitted by the operating system, run
281: ntpd
282: at the specified
283: sched_setscheduler(SCHED_FIFO)
284: priority.
285: _EndOfDoc_;
286: };
287:
288: flag = {
289: name = quit;
290: value = q;
291: descrip = "Set the time and quit";
292: doc = <<- _EndOfDoc_
293: ntpd
294: will exit just after the first time the clock is set. This behavior mimics that of the
295: ntpdate
296: program, which is to be retired.
297: The
298: -g
299: and
300: -x
301: options can be used with this option.
302: Note: The kernel time discipline is disabled with this option.
303: _EndOfDoc_;
304: };
305:
306: flag = {
307: name = propagationdelay;
308: value = r;
309: arg-type = string;
310: descrip = "Broadcast/propagation delay";
311: doc = <<- _EndOfDoc_
312: 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.
313: _EndOfDoc_;
314: };
315:
316: flag = {
317: ifdef = SAVECONFIG;
318: name = saveconfigquit;
319: arg-type = string;
320: descrip = "Save parsed configuration and quit";
321: doc = <<- _EndOfDoc_
322: Cause ntpd to parse its startup configuration file and save an
323: equivalent to the given filename and exit. This option was
324: designed for automated testing.
325: _EndOfDoc_;
326: };
327:
328: flag = {
329: name = statsdir;
330: value = s;
331: arg-type = string;
332: descrip = "Statistics file location";
333: doc = <<- _EndOfDoc_
334: Specify the directory path for files created by the statistics facility.
335: This is the same operation as the
336: statsdir statsdir
337: configuration file directive.
338: _EndOfDoc_;
339: };
340:
341: flag = {
342: name = trustedkey;
343: value = t;
344: arg-type = string;
345: descrip = "Trusted key number";
346: max = NOLIMIT;
347: arg-name = tkey;
348: stack-arg;
349: doc = <<- _EndOfDoc_
350: Add a key number to the trusted key list.
351: _EndOfDoc_;
352: };
353:
354: flag = {
355: ifdef = HAVE_DROPROOT;
356: name = user;
357: value = u;
358: arg-type = string;
359: descrip = "Run as userid (or userid:groupid)";
360: omitted-usage = "built without --enable-clockctl or --enable-linuxcaps";
361: doc = <<- _EndOfDoc_
362: Specify a user, and optionally a group, to switch to.
363: This option is only available if the OS supports adjusting the clock
364: without full root privileges.
365: This option is supported under NetBSD (configure with
366: --enable-clockctl
367: ) and Linux (configure with
368: --enable-linuxcaps
369: ).
370: _EndOfDoc_;
371: };
372:
373: flag = {
374: name = updateinterval;
375: value = U;
376: arg-type = number;
377: descrip = "interval in seconds between scans for new or dropped interfaces";
378: doc = <<- _EndOfDoc_
379: Give the time in seconds between two scans for new or dropped interfaces.
380: For systems with routing socket support the scans will be performed shortly after the interface change
381: has been detected by the system.
382: Use 0 to disable scanning. 60 seconds is the minimum time between scans.
383: _EndOfDoc_;
384: };
385:
386: flag = {
387: name = var;
388: /* value = v; Bug 817 */
389: arg-type = string;
390: descrip = "make ARG an ntp variable (RW)";
391: max = NOLIMIT;
392: arg-name = nvar;
393: stack-arg;
394: doc = <<- _EndOfDoc_
395: _EndOfDoc_;
396: };
397:
398: flag = {
399: name = dvar;
400: /* value = V; Bug 817 */
401: arg-type = string;
402: descrip = "make ARG an ntp variable (RW|DEF)";
403: max = NOLIMIT;
404: arg-name = ndvar;
405: stack-arg;
406: doc = <<- _EndOfDoc_
407: _EndOfDoc_;
408: };
409:
410: flag = {
411: name = slew;
412: value = x;
413: descrip = "Slew up to 600 seconds";
414: doc = <<- _EndOfDoc_
415: 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.
416: This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
417: 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.
418: Thus, an adjustment as much as 600 s will take almost 14 days to complete.
419: This option can be used with the
420: -g
421: and
422: -q
423: options.
424: See the
425: tinker
426: configuration file directive for other options.
427: Note: The kernel time discipline is disabled with this option.
428: _EndOfDoc_;
429: };
430:
431: flag = {
432: ifdef = SYS_WINNT;
433: name = usepcc;
434: descrip = "Use CPU cycle counter (Windows only)";
435: doc = <<- _EndOfDoc_
436: Attempt to substitute the CPU counter for QueryPerformanceCounter.
437: The CPU counter and QueryPerformanceCounter are compared, and if
438: they have the same frequency, the CPU counter (RDTSC on x86) is
439: used directly, saving the overhead of a system call.
440: _EndOfDoc_;
441: };
442:
443: flag = {
444: ifdef = SYS_WINNT;
445: name = pccfreq;
446: arg-type = string;
447: descrip = "Force CPU cycle counter use (Windows only)";
448: doc = <<- _EndOfDoc_
449: Force substitution the CPU counter for QueryPerformanceCounter.
450: The CPU counter (RDTSC on x86) is used unconditionally with the
451: given frequency (in Hz).
452: _EndOfDoc_;
453: };
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to ntpdbase-opts.def 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