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