updated output of ntpdbase-opts.def

bk: 4c37b25aUoE5USs48B3qarsU4_AHMQ

diff --git a/ntpd/ntpd-opts.c b/ntpd/ntpd-opts.c
index 635463514a60800abf0ce1ff4d9d7cbdea531cc6..a78d803652084585b091d3ce47bbfcd2a14f10c4 100644 (file)
--- a/ntpd/ntpd-opts.c
+++ b/ntpd/ntpd-opts.c
@@ -1,7 +1,7 @@
 /*  
  *  EDIT THIS FILE WITH CAUTION  (ntpd-opts.c)
  *  
- *  It has been AutoGen-ed  July  5, 2010 at 01:48:12 PM by AutoGen 5.10
+ *  It has been AutoGen-ed  July  9, 2010 at 11:31:56 PM by AutoGen 5.10
  *  From the definitions    ntpd-opts.def
  *  and the template file   options
  *
@@ -1016,7 +1016,7 @@ static tOptDesc optDesc[ OPTION_CT ] = {
  */
 tSCC   zPROGNAME[]   = "NTPD";
 tSCC   zUsageTitle[] =
-"ntpd - NTP daemon program - Ver. 4.2.7p38\n\
+"ntpd - NTP daemon program - Ver. 4.2.7p39\n\
 USAGE:  %s [ -<flag> [<val>] | --<name>[{=| }<val>] ]... \\\n\
 \t\t[ <server1> ... <serverN> ]\n";
 #define zRcName     NULL

diff --git a/ntpd/ntpd-opts.h b/ntpd/ntpd-opts.h
index 7b0cdcfd5bd706e4bbaee792109c86f3263ac366..1d68f49c195d987d8ed2fb43d234dbfc77202a56 100644 (file)
--- a/ntpd/ntpd-opts.h
+++ b/ntpd/ntpd-opts.h
@@ -1,7 +1,7 @@
 /*  
  *  EDIT THIS FILE WITH CAUTION  (ntpd-opts.h)
  *  
- *  It has been AutoGen-ed  July  5, 2010 at 01:48:12 PM by AutoGen 5.10
+ *  It has been AutoGen-ed  July  9, 2010 at 11:31:56 PM by AutoGen 5.10
  *  From the definitions    ntpd-opts.def
  *  and the template file   options
  *
@@ -91,8 +91,8 @@ typedef enum {
 } teOptIndex;
 
 #define OPTION_CT    36
-#define NTPD_VERSION       "4.2.7p38"
-#define NTPD_FULL_VERSION  "ntpd - NTP daemon program - Ver. 4.2.7p38"
+#define NTPD_VERSION       "4.2.7p39"
+#define NTPD_FULL_VERSION  "ntpd - NTP daemon program - Ver. 4.2.7p39"
 
 /*
  *  Interface defines for all options.  Replace "n" with the UPPER_CASED

diff --git a/ntpd/ntpd-opts.texi b/ntpd/ntpd-opts.texi
index bcf1d786b247b282734265265f352a9a8990e4e1..b91ed172c285bb8e5b42095508e812976035f3de 100644 (file)
--- a/ntpd/ntpd-opts.texi
+++ b/ntpd/ntpd-opts.texi
@@ -6,7 +6,7 @@
 # 
 # EDIT THIS FILE WITH CAUTION  (ntpd-opts.texi)
 # 
-# It has been AutoGen-ed  July  9, 2010 at 10:07:23 AM by AutoGen 5.10
+# It has been AutoGen-ed  July  9, 2010 at 11:32:03 PM by AutoGen 5.10
 # From the definitions    ntpd-opts.def
 # and the template file   aginfo.tpl
 @end ignore
@@ -53,6 +53,7 @@ This software is released under a specialized copyright license.
 * ntpd usepcc::                 usepcc option
 * ntpd user::                   user option (-u)
 * ntpd var::                    var option
+* ntpd wait-sync::              wait-sync option (-w)
 @end menu
 
 @node ntpd usage
@@ -64,7 +65,8 @@ This is the automatically generated usage text for ntpd:
 @exampleindent 0
 @example
 ntpd - NTP daemon program - Ver. 4.2.7p39
-USAGE:  ntpd [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
+USAGE:  ntpd [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... \
+                [ <server1> ... <serverN> ]
   Flg Arg Option-Name    Description
    -4 no  ipv4           Force IPv4 DNS name resolution
                                 - prohibits these options:
@@ -94,12 +96,20 @@ USAGE:  ntpd [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
    -l Str logfile        path to the log file
    -L no  novirtualips   Do not listen to virtual interfaces
    -n no  nofork         Do not fork
+                                - prohibits these options:
+                                wait-sync
    -N no  nice           Run at high priority
    -p Str pidfile        path to the PID file
    -P Num priority       Process priority
    -q no  quit           Set the time and quit
+                                - prohibits these options:
+                                saveconfigquit
+                                wait-sync
    -r Str propagationdelay Broadcast/propagation delay
       Str saveconfigquit Save parsed configuration and quit
+                                - prohibits these options:
+                                quit
+                                wait-sync
    -s Str statsdir       Statistics file location
    -t Str trustedkey     Trusted key number
                                 - may appear multiple times
@@ -109,8 +119,13 @@ USAGE:  ntpd [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
                                 - may appear multiple times
       Str dvar           make ARG an ntp variable (RW|DEF)
                                 - may appear multiple times
+   -w Str wait-sync      Seconds to wait for first clock sync
+                                - prohibits these options:
+                                nofork
+                                quit
+                                saveconfigquit
    -x no  slew           Slew up to 600 seconds
-      opt version        Output version information and exit
+   -! opt version        Output version information and exit
    -? no  help           Display extended usage information and exit
    -! no  more-help      Extended usage information passed thru pager
 
@@ -380,6 +395,14 @@ avoiding timekeeping glitches associated with changes.
 
 This is the ``do not fork'' option.
 
+This option has some usage constraints.  It:
+@itemize @bullet
+@item
+must not appear in combination with any of the following options:
+wait-sync.
+@end itemize
+
+
 
 @node ntpd nice
 @subsection nice option (-N)
@@ -418,10 +441,19 @@ priority.
 @cindex ntpd-quit
 
 This is the ``set the time and quit'' option.
+
+This option has some usage constraints.  It:
+@itemize @bullet
+@item
+must not appear in combination with any of the following options:
+saveconfigquit, wait-sync.
+@end itemize
+
 ntpd
-will exit just after the first time the clock is set. This behavior mimics that of the
+will not daemonize and will exit after the clock is first
+synchronized.  This behavior mimics that of the
 ntpdate
-program, which is to be retired.
+program, which will soon be replaced with a shell script.
 The
 -g
 and
@@ -446,6 +478,9 @@ This option has some usage constraints.  It:
 @itemize @bullet
 @item
 must be compiled in by defining @code{SAVECONFIG} during the compilation.
+@item
+must not appear in combination with any of the following options:
+quit, wait-sync.
 @end itemize
 
 Cause ntpd to parse its startup configuration file and save an
@@ -535,6 +570,30 @@ may appear an unlimited number of times.
 
 
 
+@node ntpd wait-sync
+@subsection wait-sync option (-w)
+@cindex ntpd-wait-sync
+
+This is the ``seconds to wait for first clock sync'' option.
+
+This option has some usage constraints.  It:
+@itemize @bullet
+@item
+must be compiled in by defining @code{HAVE_WORKING_FORK} during the compilation.
+@item
+must not appear in combination with any of the following options:
+nofork, quit, saveconfigquit.
+@end itemize
+
+If greater than zero, alters ntpd behavior when forking to
+daemonize.  Instead of exiting with status 0 immediately after
+the fork, the parent waits up to the specified number of
+seconds for the child to first synchronize the clock.  The exit
+status is zero (success) if the clock was synchronized,
+otherwise it is ETIMEDOUT.
+This provides the option for a script starting ntpd to easily
+wait for the first set of the clock before proceeding.
+
 @node ntpd slew
 @subsection slew option (-x)
 @cindex ntpd-slew

diff --git a/ntpd/ntpd.1 b/ntpd/ntpd.1
index cee715398edf969c6a65a073f9c81e92c6f84a47..9a4ccfb8e874d066988b42170999c7ed961359f0 100644 (file)
--- a/ntpd/ntpd.1
+++ b/ntpd/ntpd.1
@@ -1,7 +1,7 @@
 .TH NTPD 1 2010-07-09 "( 4.2.7p39)" "Programmer's Manual"
 .\"  EDIT THIS FILE WITH CAUTION  (ntpd.1)
 .\"  
-.\"  It has been AutoGen-ed  July  9, 2010 at 10:07:22 AM by AutoGen 5.10
+.\"  It has been AutoGen-ed  July  9, 2010 at 11:32:03 PM by AutoGen 5.10
 .\"  From the definitions    ntpd-opts.def
 .\"  and the template file   agman1.tpl
 .\"
@@ -11,8 +11,9 @@ ntpd \- NTP daemon program
 .B ntpd
 .\" Mixture of short (flag) options and long options
 .RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \--\fIopt-name\fP " [[=| ]\fIvalue\fP]]..."
-.PP
-All arguments must be options.
+.br
+.in +8
+[ <server1> ... <serverN> ]
 .SH "DESCRIPTION"
 This manual page briefly documents the \fBntpd\fP command.
 
@@ -170,6 +171,8 @@ avoiding timekeeping glitches associated with changes.
 .TP
 .BR \-n ", " \--nofork
 Do not fork.
+This option must not appear in combination with any of the following options:
+wait-sync.
 .sp
 
 .TP
@@ -202,11 +205,14 @@ priority.
 .TP
 .BR \-q ", " \--quit
 Set the time and quit.
+This option must not appear in combination with any of the following options:
+saveconfigquit, wait-sync.
 .sp
 ntpd
-will exit just after the first time the clock is set. This behavior mimics that of the
+will not daemonize and will exit after the clock is first
+synchronized.  This behavior mimics that of the
 ntpdate
-program, which is to be retired.
+program, which will soon be replaced with a shell script.
 The
 -g
 and
@@ -221,6 +227,8 @@ Specify the default propagation delay from the broadcast/multicast server to thi
 .TP
 .BR \--saveconfigquit "=\fIstring\fP"
 Save parsed configuration and quit.
+This option must not appear in combination with any of the following options:
+quit, wait-sync.
 .sp
 Cause ntpd to parse its startup configuration file and save an
 equivalent to the given filename and exit.  This option was
@@ -272,6 +280,20 @@ make ARG an ntp variable (RW|DEF).
 This option may appear an unlimited number of times.
 .sp
 
+.TP
+.BR \-w " \fIstring\fP, " \--wait-sync "=" \fIstring\fP
+Seconds to wait for first clock sync.
+This option must not appear in combination with any of the following options:
+nofork, quit, saveconfigquit.
+.sp
+If greater than zero, alters ntpd behavior when forking to
+daemonize.  Instead of exiting with status 0 immediately after
+the fork, the parent waits up to the specified number of
+seconds for the child to first synchronize the clock.  The exit
+status is zero (success) if the clock was synchronized,
+otherwise it is ETIMEDOUT.
+This provides the option for a script starting ntpd to easily
+wait for the first set of the clock before proceeding.
 .TP
 .BR \-x ", " \--slew
 Slew up to 600 seconds.