~ubuntu-branches/ubuntu/gutsy/ntp/gutsy

« back to all changes in this revision

Viewing changes to ntpd/ntpdbase-opts.def

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-05-18 22:41:56 UTC
  • mfrom: (1.2.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070518224156-563ruqxsxvqvoy8h
Tags: 1:4.2.4p0+dfsg-1ubuntu1
* Merge from Debian unstable.
* Remaining Ubuntu changes:
  - Update version in conflicts/replaces to that which was shipped in edgy,
    which was later than that in Debian (due to the ubuntuX).
  - Change default server to ntp.ubuntu.com.
  - Remove stop links from rc0 and rc6
  - Call dh_installinit with --error-handler
  - Set Ubuntu maintainer address.

Show diffs side-by-side

added added

removed removed

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