xref: /netbsd-src/external/bsd/ntp/dist/scripts/ntpsweep/ntpsweep-opts.def (revision c3ab26950fe8540fb553d1d1dcae454bc98e5a25)
1/* -*- Mode: Text -*- */
2autogen definitions perlopt;
3#include autogen-version.def
4
5prog-name      = 'ntpsweep';
6prog-title     = 'Print various informations about given ntp servers';
7package        = ntp;
8argument       = '[hostfile]';
9long-opts;
10gnu-usage;
11
12flag = {
13    name     = host-list;
14    value    = l;
15    arg-type = string;
16    max      = NOLIMIT;
17    stack-arg;
18    descrip  = 'Host to execute actions on';
19    doc      = <<- _EndOfDoc_
20            Use this option to specify the host on which this script operates.
21            May appear multiple times.
22	_EndOfDoc_;
23};
24
25flag = {
26    name    = peers;
27    value   = p;
28    descrip = 'Recursively list all peers a host synchronizes to';
29};
30
31flag = {
32    name     = maxlevel;
33    value    = m;
34    arg-type = number;
35    descrip  = 'Traverse peers up to this level (4 is a reasonable number)';
36};
37
38flag = {
39    name     = strip;
40    value    = s;
41    arg-type = string;
42    descrip  = 'Strip this string from hostnames';
43};
44
45/* Deprecated options */
46flag = {
47    name        = host;
48    value       = h;
49    arg-type    = string;
50    descrip     = 'Specify a single host';
51    deprecated;
52};
53
54doc-section	= {
55  ds-type	= 'DESCRIPTION';
56  ds-format	= 'mdoc';
57  ds-text	= <<- _END_PROG_MDOC_DESCRIP
58.Nm
59prints per host the NTP stratum level, the clock offset in seconds, the daemon
60version, the operating system and the processor. Optionally recursing through
61all peers.
62	_END_PROG_MDOC_DESCRIP;
63};
64