"Fossies" - the Fresh Open Source Software Archive

Member "ntp-4.2.8p15/scripts/ntp-wait/ntp-wait.1ntp-waitmdoc" (23 Jun 2020, 2767 Bytes) of package /linux/misc/ntp-4.2.8p15.tar.gz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "ntp-wait.1ntp-waitmdoc": 4.2.8p14_vs_4.2.8p15.

    1 .Dd June 23 2020
    2 .Dt NTP_WAIT 1ntp-waitmdoc User Commands
    3 .Os
    4 .\"  EDIT THIS FILE WITH CAUTION  (ntp-wait-opts.mdoc)
    5 .\"
    6 .\"  It has been AutoGen-ed  June 23, 2020 at 02:21:30 AM by AutoGen 5.18.5
    7 .\"  From the definitions    ntp-wait-opts.def
    8 .\"  and the template file   agmdoc-cmd.tpl
    9 .Sh NAME
   10 .Nm ntp-wait
   11 .Nd Wait for ntpd to stabilize the system clock
   12 .Sh SYNOPSIS
   13 .Nm
   14 .\" Mixture of short (flag) options and long options
   15 .Op Fl flags
   16 .Op Fl flag Op Ar value
   17 .Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
   18 .Pp
   19 All arguments must be options.
   20 .Pp
   21 .Sh DESCRIPTION
   22 .Nm
   23 will send at most
   24 .Ar num\-tries
   25 queries to
   26 .Xr ntpd 8 ,
   27 sleeping for
   28 .Ar secs\-between\-tries
   29 after each status return that says
   30 .Xr ntpd 8
   31 has not yet produced a synchronized and stable system clock.
   32 .Pp
   33 .Nm
   34 will do this quietly, unless the
   35 .Fl v
   36 flag is provided.
   37 This can be useful at boot time, to delay the boot sequence until after
   38 .Ar ntpd \-g 
   39 has set the time.
   40 .Sh "OPTIONS"
   41 .Bl -tag
   42 .It  Fl n Ar number , Fl \-tries Ns = Ns Ar number 
   43 Number of times to check ntpd.
   44 This option takes an integer number as its argument.
   45 The default
   46 .Ar number
   47 for this option is:
   48 .ti +4
   49  100
   50 .sp
   51         The maximum number of times we will check \fBntpd\fP to see if
   52         it has been able to synchronize and stabilize the system clock.
   53 .It  Fl s Ar secs\-between\-tries , Fl \-sleep Ns = Ns Ar secs\-between\-tries 
   54 How long to sleep between tries.
   55 This option takes an integer number as its argument.
   56 The default
   57 .Ar secs\-between\-tries
   58 for this option is:
   59 .ti +4
   60  6
   61 .sp
   62         We will sleep for \fIsecs\-between\-tries\fP after each query
   63         of \fBntpd\fP that returns "the time is not yet stable".
   64 .It  Fl v , Fl \-verbose 
   65 Be verbose.
   66 .sp
   67         By default, \fBntp\-wait\fP is silent.
   68         With this option, \fBntp\-wait\fP will provide status information.
   69 .It Fl \&? , Fl \-help
   70 Display usage information and exit.
   71 .It Fl \&! , Fl \-more\-help
   72 Pass the extended usage information through a pager.
   73 .It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
   74 Output version of program and exit.  The default mode is `v', a simple
   75 version.  The `c' mode will print copyright information and `n' will
   76 print the full copyright notice.
   77 .El
   78 .Sh "EXIT STATUS"
   79 One of the following exit values will be returned:
   80 .Bl -tag
   81 .It 0 " (EXIT_SUCCESS)"
   82 Successful program execution.
   83 .It 1 " (EXIT_FAILURE)"
   84 The operation failed or the command syntax was not valid.
   85 .It 70 " (EX_SOFTWARE)"
   86 libopts had an internal operational error.  Please report
   87 it to autogen\-users@lists.sourceforge.net.  Thank you.
   88 .El
   89 .Sh AUTHORS
   90 .An "Harlan Stenn"
   91 .Sh NOTES
   92 This document corresponds to version @VERSION@ of NTP.
   93 .Pp
   94 This manual page was \fIAutoGen\fP\-erated from the \fBntp\-wait\fP
   95 option definitions.