contrib/ntp/scripts/ntp-wait/ntp-wait.man.in

   1 .de1 NOP
   2 .  it 1 an-trap
   3 .  if \\n[.$] \,\\$*\/
   4 ..
   5 .ie t \
   6 .ds B-Font [CB]
   7 .ds I-Font [CI]
   8 .ds R-Font [CR]
   9 .el \
  10 .ds B-Font B
  11 .ds I-Font I
  12 .ds R-Font R
  13 .TH ntp-wait @NTP_WAIT_MS@ "26 Apr 2016" "ntp (4.2.8p7)" "User Commands"
  14 .\"
  15 .\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-LcaO9v/ag-XcaW8v)
  16 .\"
  17 .\" It has been AutoGen-ed April 26, 2016 at 08:24:20 PM by AutoGen 5.18.5
  18 .\" From the definitions ntp-wait-opts.def
  19 .\" and the template file agman-cmd.tpl
  20 .SH NAME
  21 \f\*[B-Font]ntp-wait\fP
  22 \- Wait for ntpd to stabilize the system clock
  23 .SH SYNOPSIS
  24 \f\*[B-Font]ntp-wait\fP
  25 .\" Mixture of short (flag) options and long options
  26 [\f\*[B-Font]\-flags\f[]]
  27 [\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
  28 [\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
  29 .sp \n(Ppu
  30 .ne 2
  31
  32 All arguments must be options.
  33 .sp \n(Ppu
  34 .ne 2
  35
  36 .SH DESCRIPTION
  37 \f\*[B-Font]ntp-wait\fP
  38 will send at most
  39 \f\*[I-Font]num-tries\f[]
  40 queries to
  41 \fCntpd\f[]\fR(8)\f[],
  42 sleeping for
  43 \f\*[I-Font]secs-between-tries\f[]
  44 after each status return that says
  45 \fCntpd\f[]\fR(8)\f[]
  46 has not yet produced a synchronized and stable system clock.
  47 .sp \n(Ppu
  48 .ne 2
  49
  50 \f\*[B-Font]ntp-wait\fP
  51 will do this quietly, unless the
  52 \f\*[B-Font]\-v\f[]
  53 flag is provided.
  54 This can be useful at boot time, to delay the boot sequence until after
  55 \f\*[I-Font]ntpd\f[] \f\*[I-Font]\-g\f[]
  56 has set the time.
  57 .SH "OPTIONS"
  58 .TP
  59 .NOP \f\*[B-Font]\-n\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-tries\f[]=\f\*[I-Font]number\f[]
  60 Number of times to check ntpd.
  61 This option takes an integer number as its argument.
  62 The default
  63 \f\*[I-Font]number\f[]
  64 for this option is:
  65 .ti +4
  66  100
  67 .sp
  68         The maximum number of times we will check \fBntpd\fP to see if
  69         it has been able to synchronize and stabilize the system clock.
  70 .TP
  71 .NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]secs\-between\-tries\f[], \f\*[B-Font]\-\-sleep\f[]=\f\*[I-Font]secs\-between\-tries\f[]
  72 How long to sleep between tries.
  73 This option takes an integer number as its argument.
  74 The default
  75 \f\*[I-Font]secs\-between\-tries\f[]
  76 for this option is:
  77 .ti +4
  78  6
  79 .sp
  80         We will sleep for \fIsecs-between-tries\fP after each query
  81         of \fBntpd\fP that returns "the time is not yet stable".
  82 .TP
  83 .NOP \f\*[B-Font]\-v\f[], \f\*[B-Font]\-\-verbose\f[]
  84 Be verbose.
  85 .sp
  86         By default, \fBntp-wait\fP is silent.
  87         With this option, \fBntp-wait\fP will provide status information.
  88 .TP
  89 .NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
  90 Display usage information and exit.
  91 .TP
  92 .NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
  93 Pass the extended usage information through a pager.
  94 .TP
  95 .NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]}]
  96 Output version of program and exit.  The default mode is `v', a simple
  97 version.  The `c' mode will print copyright information and `n' will
  98 print the full copyright notice.
  99 .PP
 100 .SH "EXIT STATUS"
 101 One of the following exit values will be returned:
 102 .TP
 103 .NOP 0 " (EXIT_SUCCESS)"
 104 Successful program execution.
 105 .TP
 106 .NOP 1 " (EXIT_FAILURE)"
 107 The operation failed or the command syntax was not valid.
 108 .TP
 109 .NOP 70 " (EX_SOFTWARE)"
 110 libopts had an internal operational error.  Please report
 111 it to autogen-users@lists.sourceforge.net.  Thank you.
 112 .PP
 113 .SH AUTHORS
 114 .NOP  "Harlan Stenn"
 115 .br
 116 .SH NOTES
 117 This document corresponds to version @VERSION@ of NTP.
 118 .sp \n(Ppu
 119 .ne 2
 120
 121 This manual page was \fIAutoGen\fP-erated from the \fBntp-wait\fP
 122 option definitions.