contrib/ntp/scripts/ntp-wait/invoke-ntp-wait.texi

   1 @node ntp-wait Invocation
   2 @section Invoking ntp-wait
   3 @pindex ntp-wait
   4 @cindex Wait for ntpd to stabilize the system clock
   5 @ignore
   6 #
   7 # EDIT THIS FILE WITH CAUTION  (invoke-ntp-wait.texi)
   8 #
   9 # It has been AutoGen-ed  April 26, 2016 at 08:24:23 PM by AutoGen 5.18.5
  10 # From the definitions    ntp-wait-opts.def
  11 # and the template file   agtexi-cmd.tpl
  12 @end ignore
  13
  14
  15
  16 @code{ntp-wait}
  17 will send at most
  18 @kbd{num-tries}
  19 queries to
  20 @code{ntpd(8)},
  21 sleeping for
  22 @kbd{secs-between-tries}
  23 after each status return that says
  24 @code{ntpd(8)}
  25 has not yet produced a synchronized and stable system clock.
  26
  27 @code{ntp-wait}
  28 will do this quietly, unless the
  29 @code{-v}
  30 flag is provided.
  31 This can be useful at boot time, to delay the boot sequence until after
  32 @kbd{ntpd} @kbd{-g}
  33 has set the time.
  34
  35 This section was generated by @strong{AutoGen},
  36 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntp-wait} program.
  37
  38 @menu
  39 * ntp-wait usage::                  ntp-wait help/usage (@option{--help})
  40 * ntp-wait tries::                  tries option (-n)
  41 * ntp-wait sleep::                  sleep option (-s)
  42 * ntp-wait verbose::                verbose option (-v)
  43 * ntp-wait exit status::            exit status
  44 * ntp-wait Authors::                Authors
  45 * ntp-wait Notes::                  Notes
  46 @end menu
  47
  48 @node ntp-wait usage
  49 @subsection ntp-wait help/usage (@option{--help})
  50 @cindex ntp-wait help
  51
  52 This is the automatically generated usage text for ntp-wait.
  53
  54 The text printed is the same whether selected with the @code{help} option
  55 (@option{--help}) or the @code{more-help} option (@option{--more-help}).  @code{more-help} will print
  56 the usage text by passing it through a pager program.
  57 @code{more-help} is disabled on platforms without a working
  58 @code{fork(2)} function.  The @code{PAGER} environment variable is
  59 used to select the program, defaulting to @file{more}.  Both will exit
  60 with a status code of 0.
  61
  62 @exampleindent 0
  63 @example
  64 ntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p7
  65 USAGE: ntp-wait [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
  66
  67     -n, --tries=num              Number of times to check ntpd
  68     -s, --sleep=num              How long to sleep between tries
  69     -v, --verbose                Be verbose
  70     -?, --help                   Display usage information and exit
  71         --more-help              Pass the extended usage text through a pager
  72
  73 Options are specified by doubled hyphens and their name or by a single
  74 hyphen and the flag character.
  75 @end example
  76 @exampleindent 4
  77
  78 @node ntp-wait tries
  79 @subsection tries option (-n)
  80 @cindex ntp-wait-tries
  81
  82 This is the ``number of times to check ntpd'' option.
  83 This option takes a number argument.
  84         The maximum number of times we will check @code{ntpd} to see if
  85         it has been able to synchronize and stabilize the system clock.
  86 @node ntp-wait sleep
  87 @subsection sleep option (-s)
  88 @cindex ntp-wait-sleep
  89
  90 This is the ``how long to sleep between tries'' option.
  91 This option takes a number argument @file{secs-between-tries}.
  92         We will sleep for @file{secs-between-tries} after each query
  93         of @code{ntpd} that returns "the time is not yet stable".
  94 @node ntp-wait verbose
  95 @subsection verbose option (-v)
  96 @cindex ntp-wait-verbose
  97
  98 This is the ``be verbose'' option.
  99         By default, @code{ntp-wait} is silent.
 100         With this option, @code{ntp-wait} will provide status information.
 101 @node ntp-wait exit status
 102 @subsection ntp-wait exit status
 103
 104 One of the following exit values will be returned:
 105 @table @samp
 106 @item 0 (EXIT_SUCCESS)
 107 Successful program execution.
 108 @item 1 (EXIT_FAILURE)
 109 The operation failed or the command syntax was not valid.
 110 @end table
 111 @node ntp-wait Authors
 112 @subsection ntp-wait Authors
 113 @node ntp-wait Notes
 114 @subsection ntp-wait Notes