From: Harlan Stenn Date: Fri, 31 Jan 2014 11:50:29 +0000 (+0000) Subject: Note in the deprecation of ntpdc in its documentation X-Git-Tag: NTP_4_2_7P416~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=46736a59dc7fc3401ea405a903d5e030167cea2d;p=thirdparty%2Fntp.git Note in the deprecation of ntpdc in its documentation bk: 52eb8e05KdZD7HIbb9wY_jwNZ0YQZQ --- diff --git a/ChangeLog b/ChangeLog index d01a50f80..fdc0aa66a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,4 @@ +* Note in the deprecation of ntpdc in its documentation. * [Bug 2332] Be more careful about when we use 'libgcc_s'. (4.2.7p415) 2014/01/28 Released by Harlan Stenn * Fix the man page installation for the scripts/ files. diff --git a/html/ntpdc.html b/html/ntpdc.html index 4056f03e3..38dd64083 100644 --- a/html/ntpdc.html +++ b/html/ntpdc.html @@ -4,15 +4,16 @@ ntpdc - special NTP query program +

ntpdc - special NTP query program

giffrom Alice's Adventures in Wonderland, Lewis Carroll -

This program is a big puppy.

-

Last update - 04-Sep-2010 14:15 - UTC

+

This program is a big, deprecated puppy.

+

+Modified: 31-Jan-2014 +


More Help

@@ -20,6 +21,7 @@

Synopsis

ntpdc [ -46dilnps ] [ -c command ] [ host ] [ ... ]

Description

+

ntpdc is deprecated - please use ntpq now, as it uses a more sane interface and can provide all of the information that ntpdc used to provide.

ntpdc is used to query the ntpd daemon about its current state and to request changes in that state. The program may be run either in interactive mode or controlled using command line arguments. Extensive state and statistics information is available through the ntpdc interface. In addition, nearly all the configuration options which can be specified at startup using ntpd's configuration file may also be specified at run time using ntpdc.

If one or more request options are included on the command line when ntpdc is executed, each of the requests will be sent to the NTP servers running on each of the hosts given as command line arguments, or on localhost by default. If no request options are given, ntpdc will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. ntpdc will prompt for commands if the standard input is a terminal device.

ntpdc uses NTP mode 7 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. ntpdc makes no attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time.

diff --git a/ntpdc/invoke-ntpdc.texi b/ntpdc/invoke-ntpdc.texi index 2f1cb4249..4eb5b63d0 100644 --- a/ntpdc/invoke-ntpdc.texi +++ b/ntpdc/invoke-ntpdc.texi @@ -6,13 +6,20 @@ # # EDIT THIS FILE WITH CAUTION (invoke-ntpdc.texi) # -# It has been AutoGen-ed January 28, 2014 at 12:16:31 PM by AutoGen 5.18.3pre11 +# It has been AutoGen-ed January 31, 2014 at 11:45:05 AM by AutoGen 5.18.3pre11 # From the definitions ntpdc-opts.def # and the template file agtexi-cmd.tpl @end ignore +@code{ntpdc} +is deprecated. +Please use +@code{ntpq(1ntpqmdoc)} instead - it can do everything +@code{ntpdc} +used to do, and it does so using a much more sane interface. + @code{ntpdc} is a utility program used to query @code{ntpd(1ntpdmdoc)} diff --git a/ntpdc/ntpdc-opts.c b/ntpdc/ntpdc-opts.c index 2c08c084a..ecd0a51ec 100644 --- a/ntpdc/ntpdc-opts.c +++ b/ntpdc/ntpdc-opts.c @@ -1,7 +1,7 @@ /* * EDIT THIS FILE WITH CAUTION (ntpdc-opts.c) * - * It has been AutoGen-ed January 28, 2014 at 12:16:12 PM by AutoGen 5.18.3pre11 + * It has been AutoGen-ed January 31, 2014 at 11:44:58 AM by AutoGen 5.18.3pre11 * From the definitions ntpdc-opts.def * and the template file options * diff --git a/ntpdc/ntpdc-opts.def b/ntpdc/ntpdc-opts.def index 214e82673..a7429411c 100644 --- a/ntpdc/ntpdc-opts.def +++ b/ntpdc/ntpdc-opts.def @@ -115,6 +115,13 @@ doc-section = { ds-format = 'mdoc'; ds-text = <<- _END_PROG_MDOC_DESCRIP .Nm +is deprecated. +Please use +.Xr ntpq 1ntpqmdoc instead - it can do everything +.Nm +used to do, and it does so using a much more sane interface. +.Pp +.Nm is a utility program used to query .Xr ntpd 1ntpdmdoc about its diff --git a/ntpdc/ntpdc-opts.h b/ntpdc/ntpdc-opts.h index b68698557..5bb9383c5 100644 --- a/ntpdc/ntpdc-opts.h +++ b/ntpdc/ntpdc-opts.h @@ -1,7 +1,7 @@ /* * EDIT THIS FILE WITH CAUTION (ntpdc-opts.h) * - * It has been AutoGen-ed January 28, 2014 at 12:16:12 PM by AutoGen 5.18.3pre11 + * It has been AutoGen-ed January 31, 2014 at 11:44:58 AM by AutoGen 5.18.3pre11 * From the definitions ntpdc-opts.def * and the template file options * diff --git a/ntpdc/ntpdc.1ntpdcman b/ntpdc/ntpdc.1ntpdcman index 625b06002..48bdeaf3b 100644 --- a/ntpdc/ntpdc.1ntpdcman +++ b/ntpdc/ntpdc.1ntpdcman @@ -10,11 +10,11 @@ .ds B-Font B .ds I-Font I .ds R-Font R -.TH ntpdc 1ntpdcman "28 Jan 2014" "4.2.7p415" "User Commands" +.TH ntpdc 1ntpdcman "31 Jan 2014" "4.2.7p415" "User Commands" .\" -.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-suaGQx/ag-FuaGPx) +.\" EDIT THIS FILE WITH CAUTION (in-mem file) .\" -.\" It has been AutoGen-ed January 28, 2014 at 12:16:26 PM by AutoGen 5.18.3pre11 +.\" It has been AutoGen-ed January 31, 2014 at 11:45:07 AM by AutoGen 5.18.3pre11 .\" From the definitions ntpdc-opts.def .\" and the template file agman-cmd.tpl .SH NAME @@ -31,6 +31,15 @@ .ne 2 .SH DESCRIPTION +\f\*[B-Font]ntpdc\fP +is deprecated. +Please use +\fCntpq\fR(1ntpqmdoc)\f[] instead \- it can do everything +\f\*[B-Font]ntpdc\fP +used to do, and it does so using a much more sane interface. +.sp \n(Ppu +.ne 2 + \f\*[B-Font]ntpdc\fP is a utility program used to query \fCntpd\fR(1ntpdmdoc)\f[] @@ -158,35 +167,6 @@ the configuration files. The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". If any of these are directories, then the file \fI.ntprc\fP is searched for within those directories. -.TH ntpdc 1ntpdcman "28 Jan 2014" "4.2.7p415" "User Commands" -.\" -.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-suaGQx/ag-FuaGPx) -.\" -.\" It has been AutoGen-ed January 28, 2014 at 12:16:26 PM by AutoGen 5.18.3pre11 -.\" From the definitions ntpdc-opts.def -.\" and the template file agman-cmd.tpl -.SH NAME -\f\*[B-Font]ntpdc\fP ntpdc -\- vendor-specific NTPD control program -cvt_prog='/usr/local/gnu/share/autogen/texi2man' -cvt_prog=`cd \`dirname "$cvt_prog"\` >/dev/null && pwd - `/`basename "$cvt_prog"` -cd $tmp_dir -test \-x "$cvt_prog" || die "'$cvt_prog' is not executable" -{ - list='synopsis description options option-presets' - for f in $list ; do cat $f ; echo ; done - rm \-f $list name - list='implementation-notes environment files examples exit-status errors - compatibility see-also conforming-to history authors copyright bugs - notes' - for f in $list ; do cat $f ; echo ; done > .end-doc - rm \-f $list - list=`ls \-1 *`' .end-doc' - for f in $list ; do cat $f ; echo ; done - rm \-f $list -} 1>.doc 2>/dev/null -sed \-f .cmds .doc | /opt/csw/bin/ggrep \-E \-v '^[ ]*$' | $cvt_prog .SH USAGE If one or more request options are included on the command line when diff --git a/ntpdc/ntpdc.1ntpdcmdoc b/ntpdc/ntpdc.1ntpdcmdoc index 7abd145ef..da6113128 100644 --- a/ntpdc/ntpdc.1ntpdcmdoc +++ b/ntpdc/ntpdc.1ntpdcmdoc @@ -1,9 +1,9 @@ -.Dd January 28 2014 +.Dd January 31 2014 .Dt NTPDC 1ntpdcmdoc User Commands -.Os SunOS 5.10 +.Os FreeBSD 6.4-STABLE .\" EDIT THIS FILE WITH CAUTION (ntpdc-opts.mdoc) .\" -.\" It has been AutoGen-ed January 28, 2014 at 12:16:33 PM by AutoGen 5.18.3pre11 +.\" It has been AutoGen-ed January 31, 2014 at 11:45:01 AM by AutoGen 5.18.3pre11 .\" From the definitions ntpdc-opts.def .\" and the template file agmdoc-cmd.tpl .Sh NAME @@ -19,6 +19,13 @@ .Pp .Sh DESCRIPTION .Nm +is deprecated. +Please use +.Xr ntpq 1ntpqmdoc instead \- it can do everything +.Nm +used to do, and it does so using a much more sane interface. +.Pp +.Nm is a utility program used to query .Xr ntpd 1ntpdmdoc about its @@ -131,25 +138,6 @@ the configuration files. The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". If any of these are directories, then the file \fI.ntprc\fP is searched for within those directories. -cvt_prog='/usr/local/gnu/share/autogen/texi2mdoc' -cvt_prog=`cd \`dirname "$cvt_prog"\` >/dev/null && pwd - `/`basename "$cvt_prog"` -cd $tmp_dir -test \-x "$cvt_prog" || die "'$cvt_prog' is not executable" -{ - list='synopsis description options option\-presets' - for f in $list ; do cat $f ; echo ; done - rm \-f $list name - list='implementation\-notes environment files examples exit\-status errors - compatibility see\-also conforming\-to history authors copyright bugs - notes' - for f in $list ; do cat $f ; echo ; done > .end\-doc - rm \-f $list - list=`ls \-1 *`' .end\-doc' - for f in $list ; do cat $f ; echo ; done - rm \-f $list -} 1>.doc 2>/dev/null -sed \-f .cmds .doc | /opt/csw/bin/ggrep \-E \-v '^[ ]*$' | $cvt_prog .Sh USAGE If one or more request options are included on the command line when diff --git a/ntpdc/ntpdc.html b/ntpdc/ntpdc.html index dda1797cf..bb017f705 100644 --- a/ntpdc/ntpdc.html +++ b/ntpdc/ntpdc.html @@ -3,7 +3,7 @@ ntpdc: NTPD Control User's Manual - + @@ -14,18 +14,20 @@ pre.smallformat { font-family:inherit; font-size:smaller } pre.smallexample { font-size:smaller } pre.smalllisp { font-size:smaller } - span.sc { font-variant:small-caps } - span.roman { font-family: serif; font-weight: normal; } + span.sc { font-variant:small-caps } + span.roman { font-family:serif; font-weight:normal; } + span.sansserif { font-family:sans-serif; font-weight:normal; } -->

ntpdc: NTPD Control User's Manual

+

-Next: , +Next: , Previous: (dir), Up: (dir) -
+

ntpdc: NTPD Control User Manual

@@ -55,9 +57,10 @@ IETF specification.
-

-
+

+ +
@@ -76,15 +79,23 @@ the +4.567 +/- 0.089 secs indicates the time offset and error bound of the system clock relative to the server clock.
-

-
+

+ +

Invoking ntpdc

+

ntpdc +is deprecated. +Please use +ntpq(1ntpqmdoc) instead - it can do everything +ntpdc +used to do, and it does so using a much more sane interface. +

ntpdc is a utility program used to query ntpd(1ntpdmdoc) @@ -108,7 +119,7 @@ using the agtexi-cmd template and the option descriptions for the < This software is released under the NTP license, <http://ntp.org/license>.

+

-Next: , +Next: , Up: ntpdc Invocation -
+
-

ntpdc help/usage (--help)

+

ntpdc help/usage (--help)

This is the automatically generated usage text for ntpdc.

The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print +(--help) or the more-help option (--more-help). more-help will print the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. 

ntpdc - vendor-specific NTPD control program - Ver. 4.2.7p415
@@ -193,11 +205,12 @@ Please send bug reports to:  <http://bugs.ntp.org, bugs@ntp.org>
 exit 0
+

-Next: , +Next: , Previous: ntpdc usage, Up: ntpdc Invocation -
+

ipv4 option (-4)

@@ -214,11 +227,12 @@ ipv6.

Force DNS resolution of following host names on the command line to the IPv4 namespace.

+

-Next: , +Next: , Previous: ntpdc ipv4, Up: ntpdc Invocation -
+

ipv6 option (-6)

@@ -235,18 +249,19 @@ ipv4.

Force DNS resolution of following host names on the command line to the IPv6 namespace.

+

-Next: , +Next: , Previous: ntpdc ipv6, Up: ntpdc Invocation -
+

command option (-c)

This is the “run a command and exit” option. -This option takes a string argument cmd. +This option takes a string argument cmd.

This option has some usage constraints. It:

The environment variables HOME, and PWD -are expanded and replaced when ntpdc runs. +are expanded and replaced when ntpdc runs. For any of these that are plain files, they are simply processed. -For any that are directories, then a file named .ntprc is searched for +For any that are directories, then a file named .ntprc is searched for within that directory and processed.

Configuration files may be in a wide variety of formats. @@ -422,72 +443,78 @@ detail to provide. The default is to print just the version. The licensing inf Only the first letter of the argument is examined:

-
version
Only print the version. This is the default. -
copyright
Name the copyright usage licensing terms. -
verbose
Print the full copyright usage licensing terms. +
‘version’
Only print the version. This is the default. +
‘copyright’
Name the copyright usage licensing terms. +
‘verbose’
Print the full copyright usage licensing terms.
+

-Next: , +Next: , Previous: ntpdc config, Up: ntpdc Invocation -
+

ntpdc exit status

One of the following exit values will be returned:

-
0 (EXIT_SUCCESS)
Successful program execution. -
1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid. -
66 (EX_NOINPUT)
A specified configuration file could not be loaded. -
70 (EX_SOFTWARE)
libopts had an internal operational error. Please report +
‘0 (EXIT_SUCCESS)’
Successful program execution. +
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. +
‘66 (EX_NOINPUT)’
A specified configuration file could not be loaded. +
‘70 (EX_SOFTWARE)’
libopts had an internal operational error. Please report it to autogen-users@lists.sourceforge.net. Thank you.
+

-Next: , +Next: , Previous: ntpdc exit status, Up: ntpdc Invocation -
+

ntpdc Usage

+

-Next: , +Next: , Previous: ntpdc Usage, Up: ntpdc Invocation -
+

ntpdc See Also

+

-Next: , +Next: , Previous: ntpdc See Also, Up: ntpdc Invocation -
+

ntpdc Authors

+

-Previous: ntpdc Authors, +Previous: ntpdc Authors, Up: ntpdc Invocation -
+

ntpdc Bugs

-

-
+

+ +
diff --git a/ntpdc/ntpdc.man.in b/ntpdc/ntpdc.man.in index 979c7c066..de1939bc9 100644 --- a/ntpdc/ntpdc.man.in +++ b/ntpdc/ntpdc.man.in @@ -10,11 +10,11 @@ .ds B-Font B .ds I-Font I .ds R-Font R -.TH ntpdc @NTPDC_MS@ "28 Jan 2014" "4.2.7p415" "User Commands" +.TH ntpdc @NTPDC_MS@ "31 Jan 2014" "4.2.7p415" "User Commands" .\" -.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-suaGQx/ag-FuaGPx) +.\" EDIT THIS FILE WITH CAUTION (in-mem file) .\" -.\" It has been AutoGen-ed January 28, 2014 at 12:16:26 PM by AutoGen 5.18.3pre11 +.\" It has been AutoGen-ed January 31, 2014 at 11:45:07 AM by AutoGen 5.18.3pre11 .\" From the definitions ntpdc-opts.def .\" and the template file agman-cmd.tpl .SH NAME @@ -31,6 +31,15 @@ .ne 2 .SH DESCRIPTION +\f\*[B-Font]ntpdc\fP +is deprecated. +Please use +\fCntpq\fR(@NTPQ_MS@)\f[] instead \- it can do everything +\f\*[B-Font]ntpdc\fP +used to do, and it does so using a much more sane interface. +.sp \n(Ppu +.ne 2 + \f\*[B-Font]ntpdc\fP is a utility program used to query \fCntpd\fR(@NTPD_MS@)\f[] @@ -158,35 +167,6 @@ the configuration files. The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". If any of these are directories, then the file \fI.ntprc\fP is searched for within those directories. -.TH ntpdc @NTPDC_MS@ "28 Jan 2014" "4.2.7p415" "User Commands" -.\" -.\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-suaGQx/ag-FuaGPx) -.\" -.\" It has been AutoGen-ed January 28, 2014 at 12:16:26 PM by AutoGen 5.18.3pre11 -.\" From the definitions ntpdc-opts.def -.\" and the template file agman-cmd.tpl -.SH NAME -\f\*[B-Font]ntpdc\fP ntpdc -\- vendor-specific NTPD control program -cvt_prog='/usr/local/gnu/share/autogen/texi2man' -cvt_prog=`cd \`dirname "$cvt_prog"\` >/dev/null && pwd - `/`basename "$cvt_prog"` -cd $tmp_dir -test \-x "$cvt_prog" || die "'$cvt_prog' is not executable" -{ - list='synopsis description options option-presets' - for f in $list ; do cat $f ; echo ; done - rm \-f $list name - list='implementation-notes environment files examples exit-status errors - compatibility see-also conforming-to history authors copyright bugs - notes' - for f in $list ; do cat $f ; echo ; done > .end-doc - rm \-f $list - list=`ls \-1 *`' .end-doc' - for f in $list ; do cat $f ; echo ; done - rm \-f $list -} 1>.doc 2>/dev/null -sed \-f .cmds .doc | /opt/csw/bin/ggrep \-E \-v '^[ ]*$' | $cvt_prog .SH USAGE If one or more request options are included on the command line when diff --git a/ntpdc/ntpdc.mdoc.in b/ntpdc/ntpdc.mdoc.in index d32929d46..02fd3f09d 100644 --- a/ntpdc/ntpdc.mdoc.in +++ b/ntpdc/ntpdc.mdoc.in @@ -1,9 +1,9 @@ -.Dd January 28 2014 +.Dd January 31 2014 .Dt NTPDC @NTPDC_MS@ User Commands -.Os SunOS 5.10 +.Os FreeBSD 6.4-STABLE .\" EDIT THIS FILE WITH CAUTION (ntpdc-opts.mdoc) .\" -.\" It has been AutoGen-ed January 28, 2014 at 12:16:33 PM by AutoGen 5.18.3pre11 +.\" It has been AutoGen-ed January 31, 2014 at 11:45:01 AM by AutoGen 5.18.3pre11 .\" From the definitions ntpdc-opts.def .\" and the template file agmdoc-cmd.tpl .Sh NAME @@ -19,6 +19,13 @@ .Pp .Sh DESCRIPTION .Nm +is deprecated. +Please use +.Xr ntpq @NTPQ_MS@ instead \- it can do everything +.Nm +used to do, and it does so using a much more sane interface. +.Pp +.Nm is a utility program used to query .Xr ntpd @NTPD_MS@ about its @@ -131,25 +138,6 @@ the configuration files. The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". If any of these are directories, then the file \fI.ntprc\fP is searched for within those directories. -cvt_prog='/usr/local/gnu/share/autogen/texi2mdoc' -cvt_prog=`cd \`dirname "$cvt_prog"\` >/dev/null && pwd - `/`basename "$cvt_prog"` -cd $tmp_dir -test \-x "$cvt_prog" || die "'$cvt_prog' is not executable" -{ - list='synopsis description options option\-presets' - for f in $list ; do cat $f ; echo ; done - rm \-f $list name - list='implementation\-notes environment files examples exit\-status errors - compatibility see\-also conforming\-to history authors copyright bugs - notes' - for f in $list ; do cat $f ; echo ; done > .end\-doc - rm \-f $list - list=`ls \-1 *`' .end\-doc' - for f in $list ; do cat $f ; echo ; done - rm \-f $list -} 1>.doc 2>/dev/null -sed \-f .cmds .doc | /opt/csw/bin/ggrep \-E \-v '^[ ]*$' | $cvt_prog .Sh USAGE If one or more request options are included on the command line when