xref: /freebsd/contrib/ntp/scripts/ntpsweep/ntpsweep-opts (revision f5f40dd63bc7acbb5312b26ac1ea1103c12352a6)
12b15cb3dSCy Schubert# EDIT THIS FILE WITH CAUTION  (ntpsweep-opts)
22b15cb3dSCy Schubert#
3*f5f40dd6SCy Schubert# It has been AutoGen-ed  May 25, 2024 at 12:05:41 AM by AutoGen 5.18.16
42b15cb3dSCy Schubert# From the definitions    ntpsweep-opts.def
52b15cb3dSCy Schubert# and the template file   perlopt
62b15cb3dSCy Schubert
72b15cb3dSCy Schubertuse Getopt::Long qw(GetOptionsFromArray);
82b15cb3dSCy SchubertGetopt::Long::Configure(qw(no_auto_abbrev no_ignore_case_always));
92b15cb3dSCy Schubert
102b15cb3dSCy Schubertmy $usage;
112b15cb3dSCy Schubert
122b15cb3dSCy Schubertsub usage {
132b15cb3dSCy Schubert    my ($ret) = @_;
142b15cb3dSCy Schubert    print STDERR $usage;
152b15cb3dSCy Schubert    exit $ret;
162b15cb3dSCy Schubert}
172b15cb3dSCy Schubert
182b15cb3dSCy Schubertsub paged_usage {
192b15cb3dSCy Schubert    my ($ret) = @_;
202b15cb3dSCy Schubert    my $pager = $ENV{PAGER} || '(less || more)';
212b15cb3dSCy Schubert
222b15cb3dSCy Schubert    open STDOUT, "| $pager" or die "Can't fork a pager: $!";
232b15cb3dSCy Schubert    print $usage;
242b15cb3dSCy Schubert
252b15cb3dSCy Schubert    exit $ret;
262b15cb3dSCy Schubert}
272b15cb3dSCy Schubert
282b15cb3dSCy Schubertsub processOptions {
292b15cb3dSCy Schubert    my $args = shift;
302b15cb3dSCy Schubert
312b15cb3dSCy Schubert    my $opts = {
322b15cb3dSCy Schubert        'host-list' => [],
332b15cb3dSCy Schubert        'peers' => '',
342b15cb3dSCy Schubert        'maxlevel' => '',
352b15cb3dSCy Schubert        'strip' => '',
362b15cb3dSCy Schubert        'host' => '',
372b15cb3dSCy Schubert        'help' => '', 'more-help' => ''
382b15cb3dSCy Schubert    };
392b15cb3dSCy Schubert    my $argument = '[hostfile]';
402b15cb3dSCy Schubert    my $ret = GetOptionsFromArray($args, $opts, (
412b15cb3dSCy Schubert        'host-list|l=s', 'peers|p', 'maxlevel|m=i',
422b15cb3dSCy Schubert        'strip|s=s', 'host|h=s',
432b15cb3dSCy Schubert        'help|?', 'more-help'));
442b15cb3dSCy Schubert
452b15cb3dSCy Schubert    $usage = <<'USAGE';
46*f5f40dd6SCy Schubertntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p18
472b15cb3dSCy SchubertUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile]
482b15cb3dSCy Schubert
492b15cb3dSCy Schubert    -l, --host-list=str          Host to execute actions on
502b15cb3dSCy Schubert                                   - may appear multiple times
512b15cb3dSCy Schubert    -p, --peers                  Recursively list all peers a host synchronizes to
522b15cb3dSCy Schubert    -m, --maxlevel=num           Traverse peers up to this level (4 is a reasonable number)
532b15cb3dSCy Schubert    -s, --strip=str              Strip this string from hostnames
542b15cb3dSCy Schubert    -?, --help                   Display usage information and exit
552b15cb3dSCy Schubert        --more-help              Pass the extended usage text through a pager
562b15cb3dSCy Schubert
572b15cb3dSCy SchubertOptions are specified by doubled hyphens and their name or by a single
582b15cb3dSCy Schuberthyphen and the flag character.
592b15cb3dSCy SchubertUSAGE
602b15cb3dSCy Schubert
612b15cb3dSCy Schubert    usage(0)       if $opts->{'help'};
622b15cb3dSCy Schubert    paged_usage(0) if $opts->{'more-help'};
632b15cb3dSCy Schubert    $_[0] = $opts;
642b15cb3dSCy Schubert    return $ret;
652b15cb3dSCy Schubert}
662b15cb3dSCy Schubert
672b15cb3dSCy SchubertEND { close STDOUT };
68