1275970Scy/* -*- Mode: Text -*- */ 2275970ScyAutoGen Definitions perlopt; 3275970Scy 4275970Scy#include autogen-version.def 5275970Scy 6275970Scyprog-name = "ntp-wait"; 7275970Scyprog-title = "Wait for ntpd to stabilize the system clock"; 8275970Scypackage = ntp; 9275970Scy#include version.def 10275970Scy 11275970Scylong-opts; 12275970Scygnu-usage; 13275970Scy 14275970Scyflag = { 15275970Scy name = tries; 16275970Scy value = n; 17275970Scy arg-type = number; 18275970Scy arg-default = 100; 19275970Scy descrip = "Number of times to check ntpd"; 20275970Scy doc = <<- _EndOfDoc_ 21275970Scy The maximum number of times we will check @code{ntpd} to see if 22275970Scy it has been able to synchronize and stabilize the system clock. 23275970Scy _EndOfDoc_; 24275970Scy}; 25275970Scy 26275970Scyflag = { 27275970Scy name = sleep; 28275970Scy value = s; 29275970Scy arg-type = number; 30275970Scy arg-name = "secs-between-tries"; 31275970Scy arg-default = 6; 32275970Scy descrip = "How long to sleep between tries"; 33275970Scy doc = <<- _EndOfDoc_ 34275970Scy We will sleep for @file{secs-between-tries} after each query 35275970Scy of @code{ntpd} that returns "the time is not yet stable". 36275970Scy _EndOfDoc_; 37275970Scy}; 38275970Scy 39275970Scyflag = { 40275970Scy name = verbose; 41275970Scy value = v; 42275970Scy descrip = "Be verbose"; 43275970Scy doc = <<- _EndOfDoc_ 44275970Scy By default, @code{ntp-wait} is silent. 45275970Scy With this option, @code{ntp-wait} will provide status information. 46275970Scy _EndOfDoc_; 47275970Scy}; 48275970Scy 49275970Scyexplain = <<- _END_EXPLAIN 50275970Scy _END_EXPLAIN; 51275970Scy 52275970Scydoc-section = { 53275970Scy ds-type = 'DESCRIPTION'; 54275970Scy ds-format = 'mdoc'; 55275970Scy ds-text = <<- _END_PROG_MDOC_DESCRIP 56275970Scy.Nm 57275970Scywill send at most 58275970Scy.Ar num-tries 59275970Scyqueries to 60275970Scy.Xr ntpd 8 , 61275970Scysleeping for 62275970Scy.Ar secs-between-tries 63275970Scyafter each status return that says 64275970Scy.Xr ntpd 8 65275970Scyhas not yet produced a synchronized and stable system clock. 66275970Scy.Pp 67275970Scy.Nm 68275970Scywill do this quietly, unless the 69275970Scy.Fl v 70275970Scyflag is provided. 71275970ScyThis can be useful at boot time, to delay the boot sequence until after 72275970Scy.Ar ntpd -g 73275970Scyhas set the time. 74275970Scy _END_PROG_MDOC_DESCRIP; 75275970Scy}; 76275970Scy 77275970Scy/* 78275970Scydoc-section = { 79275970Scy ds-type = 'USAGE'; 80275970Scy ds-format = 'mdoc'; 81275970Scy ds-text = <<- _END_MDOC_USAGE 82275970Scy _END_MDOC_USAGE; 83275970Scy}; 84275970Scy*/ 85275970Scy 86275970Scydoc-section = { 87275970Scy ds-type = 'AUTHORS'; 88275970Scy ds-format = 'mdoc'; 89275970Scy ds-text = <<- _END_MDOC_AUTH 90275970Scy.An "Harlan Stenn" 91275970Scy _END_MDOC_AUTH; 92275970Scy}; 93275970Scy 94275970Scydoc-section = { 95275970Scy ds-type = 'NOTES'; 96275970Scy ds-format = 'mdoc'; 97275970Scy ds-text = <<- _END_MDOC_NOTES 98275970ScyThis document corresponds to version @VERSION@ of NTP. 99275970Scy _END_MDOC_NOTES; 100275970Scy}; 101275970Scy 102275970Scy/* 103275970Scydoc-section = { 104275970Scy ds-type = 'BUGS'; 105275970Scy ds-format = 'mdoc'; 106275970Scy ds-text = <<- _END_MDOC_BUGS 107275970Scy _END_MDOC_BUGS; 108275970Scy}; 109275970Scy*/ 110