contrib/ntp/scripts/ntp-wait/ntp-wait-opts.def

   1 /* -*- Mode: Text -*- */
   2 AutoGen Definitions perlopt;
   3
   4 #include autogen-version.def
   5
   6 prog-name       = "ntp-wait";
   7 prog-title      = "Wait for ntpd to stabilize the system clock";
   8 package         = ntp;
   9 #include        version.def
  10
  11 long-opts;
  12 gnu-usage;
  13
  14 flag = {
  15     name        = tries;
  16     value       = n;
  17     arg-type    = number;
  18     arg-default = 100;
  19     descrip     = "Number of times to check ntpd";
  20     doc         = <<-  _EndOfDoc_
  21         The maximum number of times we will check @code{ntpd} to see if
  22         it has been able to synchronize and stabilize the system clock.
  23         _EndOfDoc_;
  24 };
  25
  26 flag = {
  27     name        = sleep;
  28     value       = s;
  29     arg-type    = number;
  30     arg-name    = "secs-between-tries";
  31     arg-default = 6;
  32     descrip     = "How long to sleep between tries";
  33     doc         = <<-  _EndOfDoc_
  34         We will sleep for @file{secs-between-tries} after each query
  35         of @code{ntpd} that returns "the time is not yet stable".
  36         _EndOfDoc_;
  37 };
  38
  39 flag = {
  40     name    = verbose;
  41     value   = v;
  42     descrip = "Be verbose";
  43     doc     = <<-  _EndOfDoc_
  44         By default, @code{ntp-wait} is silent.
  45         With this option, @code{ntp-wait} will provide status information.
  46         _EndOfDoc_;
  47 };
  48
  49 explain = <<- _END_EXPLAIN
  50         _END_EXPLAIN;
  51
  52 doc-section     = {
  53   ds-type       = 'DESCRIPTION';
  54   ds-format     = 'mdoc';
  55   ds-text       = <<- _END_PROG_MDOC_DESCRIP
  56 .Nm
  57 will send at most
  58 .Ar num-tries
  59 queries to
  60 .Xr ntpd 8 ,
  61 sleeping for
  62 .Ar secs-between-tries
  63 after each status return that says
  64 .Xr ntpd 8
  65 has not yet produced a synchronized and stable system clock.
  66 .Pp
  67 .Nm
  68 will do this quietly, unless the
  69 .Fl v
  70 flag is provided.
  71 This can be useful at boot time, to delay the boot sequence until after
  72 .Ar ntpd -g
  73 has set the time.
  74         _END_PROG_MDOC_DESCRIP;
  75 };
  76
  77 /*
  78 doc-section     = {
  79   ds-type       = 'USAGE';
  80   ds-format     = 'mdoc';
  81   ds-text       = <<- _END_MDOC_USAGE
  82         _END_MDOC_USAGE;
  83 };
  84 */
  85
  86 doc-section     = {
  87   ds-type       = 'AUTHORS';
  88   ds-format     = 'mdoc';
  89   ds-text       = <<- _END_MDOC_AUTH
  90 .An "Harlan Stenn"
  91         _END_MDOC_AUTH;
  92 };
  93
  94 doc-section     = {
  95   ds-type       = 'NOTES';
  96   ds-format     = 'mdoc';
  97   ds-text       = <<- _END_MDOC_NOTES
  98 This document corresponds to version @VERSION@ of NTP.
  99         _END_MDOC_NOTES;
 100 };
 101
 102 /*
 103 doc-section     = {
 104   ds-type       = 'BUGS';
 105   ds-format     = 'mdoc';
 106   ds-text       = <<- _END_MDOC_BUGS
 107         _END_MDOC_BUGS;
 108 };
 109 */