From: Harlan Stenn Date: Fri, 4 Jan 2013 09:05:47 +0000 (+0000) Subject: NTP_4_2_7P345 X-Git-Tag: NTP_4_2_7P345^0 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f3df16f40dde5c0b549a90bda034d40b3873589c;p=thirdparty%2Fntp.git NTP_4_2_7P345 bk: 50e69b6bDteSv_LolUuMBLOhq0BSSA --- diff --git a/ChangeLog b/ChangeLog index 0faa31a89..5a1037b65 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,4 @@ +(4.2.7p345) 2013/01/04 Released by Harlan Stenn * Update several .def files to use autogen-5.17 feature set. (4.2.7p344) 2013/01/03 Released by Harlan Stenn * Refactor and enhance mdoc2texi. diff --git a/ntpd/invoke-ntp.conf.texi b/ntpd/invoke-ntp.conf.texi index 701af3c3e..4b12faa36 100644 --- a/ntpd/invoke-ntp.conf.texi +++ b/ntpd/invoke-ntp.conf.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (invoke-ntp.conf.texi) # -# It has been AutoGen-ed January 3, 2013 at 01:09:25 PM by AutoGen 5.17.1pre11 +# It has been AutoGen-ed January 4, 2013 at 09:03:01 AM by AutoGen 5.17.1pre11 # From the definitions ntp.conf.def # and the template file agtexi-file.tpl @end ignore @@ -2716,5 +2716,5 @@ These should be obtained via secure directory services when they become universally available. @node ntp.conf Notes @subsection ntp.conf Notes -This document corresponds to version @VERSION@ of NTP. +This document corresponds to version #VERSION# of NTP. This document was derived from FreeBSD. diff --git a/ntpd/invoke-ntp.keys.texi b/ntpd/invoke-ntp.keys.texi index 879ee25cb..f5ad52a0a 100644 --- a/ntpd/invoke-ntp.keys.texi +++ b/ntpd/invoke-ntp.keys.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (invoke-ntp.keys.texi) # -# It has been AutoGen-ed January 3, 2013 at 01:09:27 PM by AutoGen 5.17.1pre11 +# It has been AutoGen-ed January 4, 2013 at 09:03:03 AM by AutoGen 5.17.1pre11 # From the definitions ntp.keys.def # and the template file agtexi-file.tpl @end ignore @@ -124,5 +124,5 @@ the default name of the configuration file @code{sntp(1sntpmdoc)} @node ntp.keys Notes @subsection ntp.keys Notes -This document corresponds to version @VERSION@ of NTP. +This document corresponds to version #VERSION# of NTP. This document was derived from FreeBSD. diff --git a/ntpd/invoke-ntpd.texi b/ntpd/invoke-ntpd.texi index d51cb49ee..bedacbb1d 100644 --- a/ntpd/invoke-ntpd.texi +++ b/ntpd/invoke-ntpd.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (invoke-ntpd.texi) # -# It has been AutoGen-ed January 3, 2013 at 01:09:28 PM by AutoGen 5.17.1pre11 +# It has been AutoGen-ed January 4, 2013 at 09:03:04 AM by AutoGen 5.17.1pre11 # From the definitions ntpd-opts.def # and the template file agtexi-cmd.tpl @end ignore @@ -141,7 +141,7 @@ with a status code of 0. @exampleindent 0 @example -ntpd - NTP daemon program - Ver. 4.2.7p344 +ntpd - NTP daemon program - Ver. 4.2.7p345 USAGE: ntpd [ - [] | --[@{=| @}] ]... \ [ ... ] Flg Arg Option-Name Description @@ -674,8 +674,8 @@ The command line options relating to configuration and/or usage help are: Print the program version to standard out, optionally with licensing information, then exit 0. The optional argument specifies how much licensing -detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. Only the -first letter of the argument is examined: +detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. +Only the first letter of the argument is examined: @table @samp @item version @@ -1173,5 +1173,5 @@ a busy primary server, rather than a high stratum workstation in mind. @node ntpd Notes @subsection ntpd Notes -This document corresponds to version @VERSION@ of NTP. +This document corresponds to version 4.2.7p345 of NTP. Portions of this document came from FreeBSD. diff --git a/ntpd/ntp.conf.5man b/ntpd/ntp.conf.5man index 1c46d1821..7d9eede4b 100644 --- a/ntpd/ntp.conf.5man +++ b/ntpd/ntp.conf.5man @@ -1,8 +1,8 @@ -.TH ntp.conf 5man "03 Jan 2013" "4.2.7p344" "File Formats" +.TH ntp.conf 5man "04 Jan 2013" "4.2.7p345" "File Formats" .\" .\" EDIT THIS FILE WITH CAUTION (ntp.man) .\" -.\" It has been AutoGen-ed January 3, 2013 at 01:09:10 PM by AutoGen 5.17.1pre11 +.\" It has been AutoGen-ed January 4, 2013 at 09:02:47 AM by AutoGen 5.17.1pre11 .\" From the definitions ntp.conf.def .\" and the template file agman-cmd.tpl .\" @@ -1165,7 +1165,7 @@ the file generation set named The first two fields show the date (Modified Julian Day) and time (seconds and fraction past UTC midnight). The next five fields -show time offset (seconds), frequency offset (parts per million - +show time offset (seconds), frequency offset (parts per million \- PPM), RMS jitter (seconds), Allan deviation (PPM) and clock discipline time constant. .ti -4 @@ -1181,7 +1181,7 @@ generation set named .br .in +4 .nf -48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000 0.001424877 0.000958674 +48773 10847.650 127.127.4.1 9714 \-0.001605376 0.000000000 0.001424877 0.000958674 .in -4 .fi .PP @@ -2618,7 +2618,7 @@ keywords can be prefixed with .Ql = , .Ql + and -.Ql - , +.Ql \- , where .Ql = sets the @@ -2626,7 +2626,7 @@ sets the priority mask, .Ql + adds and -.Ql - +.Ql \- removes messages. .Xr syslog 3 @@ -2698,7 +2698,7 @@ This command specifies the location of an alternate log file to be used instead of the default system .Xr syslog 3 facility. -This is the same operation as the -l command line option. +This is the same operation as the \-l command line option. .TP .BR Ic setvar Ar variable Op Cm default This command adds an additional system variable. @@ -2850,6 +2850,46 @@ In manycast mode these values are used in turn in an expanding-ring search. The default is eight multiples of 32 starting at 31. +.SH "OPTIONS" +.TP +.BR \-\-help +Display usage information and exit. +.TP +.BR \-\-more-help +Pass the extended usage information through a pager. +.TP +.BR \-\-version "[=\fI{v|c|n}\fP]" +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.SH "OPTION PRESETS" +Any option that is not marked as \fInot presettable\fP may be preset +by loading values from environment variables named: +.nf + \fBNTP_CONF_\fP or \fBNTP_CONF\fP +.fi +.ad +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 | /usr/local/gnu/bin/grep \-E \-v '^[ ]*$' | $cvt_prog +.SH "ENVIRONMENT" +See \fBOPTION PRESETS\fP for configuration environment variables. .SH FILES .TP .BR Pa /etc/ntp.conf @@ -2866,6 +2906,18 @@ RSA public key .TP .BR Pa ntp_dh Diffie-Hellman agreement parameters +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.BR 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.BR 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.TP +.BR 70 " (EX_SOFTWARE)" +libopts had an internal operational error. Please report +it to autogen-users@lists.sourceforge.net. Thank you. .SH "SEE ALSO" .SH SEE ALSO .Xr ntpd 1ntpdmdoc , @@ -2900,8 +2952,7 @@ certificates. These should be obtained via secure directory services when they become universally available.Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org .SH NOTES -This document corresponds to version @VERSION@ of NTP. -This document was derived from FreeBSD. -.PP +This document corresponds to version 4.2.7p345 of NTP. +This document was derived from FreeBSD..Pp This manual page was \fIAutoGen\fP-erated from the \fBntp.conf\fP option definitions. diff --git a/ntpd/ntp.conf.5mdoc b/ntpd/ntp.conf.5mdoc index f79966395..40ee65c70 100644 --- a/ntpd/ntp.conf.5mdoc +++ b/ntpd/ntp.conf.5mdoc @@ -1,9 +1,9 @@ -.Dd January 3 2013 +.Dd January 4 2013 .Dt NTP_CONF 5mdoc File Formats .Os SunOS 5.10 .\" EDIT THIS FILE WITH CAUTION (ntp.mdoc) .\" -.\" It has been AutoGen-ed January 3, 2013 at 01:09:31 PM by AutoGen 5.17.1pre11 +.\" It has been AutoGen-ed January 4, 2013 at 09:03:06 AM by AutoGen 5.17.1pre11 .\" From the definitions ntp.conf.def .\" and the template file agmdoc-cmd.tpl .Sh NAME @@ -11,8 +11,8 @@ .Nd Network Time Protocol (NTP) daemon configuration file format .Sh SYNOPSIS .Nm -.Op Fl \-option-name -.Op Fl \-option-name Ar value +.Op Fl \-option\-name +.Op Fl \-option\-name Ar value .Pp All arguments must be options. .Pp @@ -43,7 +43,7 @@ followed by a list of arguments, some of which may be optional, separated by whitespace. Commands may not be continued over multiple lines. Arguments may be host names, -host addresses written in numeric, dotted-quad form, +host addresses written in numeric, dotted\-quad form, integers, floating point numbers (when specifying times in seconds) and text strings. .Pp @@ -108,7 +108,7 @@ Use of options not listed may not be caught as an error, but may result in some weird and even destructive behavior. .Pp -If the Basic Socket Interface Extensions for IPv6 (RFC-2553) +If the Basic Socket Interface Extensions for IPv6 (RFC\-2553) is detected, support for the IPv6 address family is generated in addition to the default support of the IPv4 address family. In a few cases, including the reslist billboard generated @@ -177,7 +177,7 @@ be used and the mode in which to operate. The .Ar address can be -either a DNS name or an IP address in dotted-quad notation. +either a DNS name or an IP address in dotted\-quad notation. Additional information on association behavior can be found in the .Qq Association Management page @@ -204,7 +204,7 @@ be used for type b or m addresses. .It Ic peer For type s addresses (only), this command mobilizes a -persistent symmetric-active mode association with the specified +persistent symmetric\-active mode association with the specified remote peer. In this mode the local clock can be synchronized to the remote peer or the remote peer can be synchronized to the local @@ -345,7 +345,7 @@ for further information. .It Cm ttl Ar ttl This option is used only with broadcast server and manycast client modes. -It specifies the time-to-live +It specifies the time\-to\-live .Ar ttl to use on broadcast server and multicast server and the maximum @@ -358,7 +358,7 @@ network administrator. .It Cm version Ar version Specifies the version number to be used for outgoing NTP packets. -Versions 1-4 are the choices, with version 4 the +Versions 1\-4 are the choices, with version 4 the default. .El .Ss Auxiliary Commands @@ -373,7 +373,7 @@ server, then enters the broadcast client mode, in which it synchronizes to succeeding broadcast messages. Note that, in order to avoid accidental or malicious disruption in this mode, both the -server and client should operate using symmetric-key or public-key +server and client should operate using symmetric\-key or public\-key authentication as described in .Sx Authentication Options . .It Ic manycastserver Ar address ... @@ -386,7 +386,7 @@ taken to limit the span of the reply and avoid a possibly massive implosion at the original sender. Note that, in order to avoid accidental or malicious disruption in this mode, both the server -and client should operate using symmetric-key or public-key +and client should operate using symmetric\-key or public\-key authentication as described in .Sx Authentication Options . .It Ic multicastclient Ar address ... @@ -399,8 +399,8 @@ exchange with the server, then enters the broadcast client mode, in which it synchronizes to succeeding multicast messages. Note that, in order to avoid accidental or malicious disruption in this mode, -both the server and client should operate using symmetric-key or -public-key authentication as described in +both the server and client should operate using symmetric\-key or +public\-key authentication as described in .Sx Authentication Options . .El .Sh Authentication Support @@ -408,15 +408,15 @@ Authentication support allows the NTP client to verify that the server is in fact known and trusted and not an intruder intending accidentally or on purpose to masquerade as that server. The NTPv3 -specification RFC-1305 defines a scheme which provides +specification RFC\-1305 defines a scheme which provides cryptographic authentication of received NTP packets. Originally, this was done using the Data Encryption Standard (DES) algorithm operating in Cipher Block Chaining (CBC) mode, commonly called -DES-CBC. +DES\-CBC. Subsequently, this was replaced by the RSA Message Digest -5 (MD5) algorithm using a private key, commonly called keyed-MD5. -Either algorithm computes a message digest, or one-way hash, which +5 (MD5) algorithm using a private key, commonly called keyed\-MD5. +Either algorithm computes a message digest, or one\-way hash, which can be used to verify the server has the correct private key and key identifier. .Pp @@ -537,9 +537,9 @@ cryptography are summarized below; further details are in the briefings, papers and reports at the NTP project page linked from .Li http://www.ntp.org/ . -.Ss Symmetric-Key Cryptography -The original RFC-1305 specification allows any one of possibly -65,534 keys, each distinguished by a 32-bit key identifier, to +.Ss Symmetric\-Key Cryptography +The original RFC\-1305 specification allows any one of possibly +65,534 keys, each distinguished by a 32\-bit key identifier, to authenticate an association. The servers and clients involved must agree on the key and key identifier to @@ -587,7 +587,7 @@ command selects the key used as the password for the utility. .Ss Public Key Cryptography NTPv4 supports the original NTPv3 symmetric key scheme -described in RFC-1305 and in addition the Autokey protocol, +described in RFC\-1305 and in addition the Autokey protocol, which is based on public key cryptography. The Autokey Version 2 protocol described on the Autokey Protocol page verifies packet integrity using MD5 message digests @@ -615,8 +615,8 @@ corresponding to the various NTP modes supported. Most modes use a special cookie which can be computed independently by the client and server, but encrypted in transmission. -All modes use in addition a variant of the S-KEY scheme, -in which a pseudo-random key list is generated and used +All modes use in addition a variant of the S\-KEY scheme, +in which a pseudo\-random key list is generated and used in reverse order. These schemes are described along with an executive summary, current status, briefing slides and reading list on the @@ -626,7 +626,7 @@ page. The specific cryptographic environment used by Autokey servers and clients is determined by a set of files and soft links generated by the -.Xr ntp-keygen 1ntpkeygenmdoc +.Xr ntp\-keygen 1ntpkeygenmdoc program. This includes a required host key file, required certificate file and optional sign key file, @@ -756,7 +756,7 @@ If it's the same key and the message is verified, Bob sends Cathy a reply authenticated with that key. If verification fails, -Bob sends Cathy a thing called a crypto-NAK, which tells her +Bob sends Cathy a thing called a crypto\-NAK, which tells her something broke. She can see the evidence using the .Xr ntpq 1ntpqmdoc @@ -780,7 +780,7 @@ with one server and no authentication with another might not be wise. .Ss Key Management The cryptographic values used by the Autokey protocol are incorporated as a set of files generated by the -.Xr ntp-keygen 1ntpkeygenmdoc +.Xr ntp\-keygen 1ntpkeygenmdoc utility program, including symmetric key, host key and public certificate files, as well as sign key, identity parameters and leapseconds files. @@ -828,7 +828,7 @@ sent. Specifies the key identifier to use with the .Xr ntpq 1ntpqmdoc utility, which uses the standard -protocol defined in RFC-1305. +protocol defined in RFC\-1305. The .Ar key argument is @@ -940,11 +940,11 @@ argument is a key identifier for the trusted key, where the value can be in the range 1 to 65,534, inclusive. .It Ic revoke Ar logsec -Specifies the interval between re-randomization of certain +Specifies the interval between re\-randomization of certain cryptographic values used by the Autokey scheme, as a power of 2 in seconds. These values need to be updated frequently in order to -deflect brute-force attacks on the algorithms of the scheme; +deflect brute\-force attacks on the algorithms of the scheme; however, updating some values is a relatively expensive operation. The default interval is 16 (65,536 s or about 18 hours). For poll @@ -964,7 +964,7 @@ purpose, although different keys can be used with different servers. The .Ar key -arguments are 32-bit unsigned +arguments are 32\-bit unsigned integers with values from 1 to 65,534. .El .Ss Error Codes @@ -1060,7 +1060,7 @@ the file generation set named The first two fields show the date (Modified Julian Day) and time (seconds and fraction past UTC midnight). The next field shows the -clock address in dotted-quad notation. +clock address in dotted\-quad notation. The final field shows the last timecode received from the clock in decoded ASCII format, where meaningful. @@ -1082,7 +1082,7 @@ following form to the file generation set named The first two fields show the date (Modified Julian Day) and time (seconds and fraction past UTC midnight). The next field shows the peer -address in dotted-quad notation, The final message field includes the +address in dotted\-quad notation, The final message field includes the message type and certain ancillary information. See the .Sx Authentication Options @@ -1100,7 +1100,7 @@ the file generation set named The first two fields show the date (Modified Julian Day) and time (seconds and fraction past UTC midnight). The next five fields -show time offset (seconds), frequency offset (parts per million - +show time offset (seconds), frequency offset (parts per million \- PPM), RMS jitter (seconds), Allan deviation (PPM) and clock discipline time constant. .It Cm peerstats @@ -1113,20 +1113,20 @@ line of the following form to the current element of a file generation set named .Cm peerstats : .Bd -literal -48773 10847.650 127.127.4.1 9714 -0.001605376 0.000000000 0.001424877 0.000958674 +48773 10847.650 127.127.4.1 9714 \-0.001605376 0.000000000 0.001424877 0.000958674 .Ed .Pp The first two fields show the date (Modified Julian Day) and time (seconds and fraction past UTC midnight). The next two fields -show the peer address in dotted-quad notation and status, +show the peer address in dotted\-quad notation and status, respectively. The status field is encoded in hex in the format described in Appendix A of the NTP specification RFC 1305. The final four fields show the offset, delay, dispersion and RMS jitter, all in seconds. .It Cm rawstats -Enables recording of raw-timestamp statistics information. +Enables recording of raw\-timestamp statistics information. This includes statistics records of all peers of a NTP server and of special signals, where present and configured. @@ -1142,7 +1142,7 @@ The first two fields show the date (Modified Julian Day) and time (seconds and fraction past UTC midnight). The next two fields show the remote peer or clock address followed by the local address -in dotted-quad notation. +in dotted\-quad notation. The final four fields show the originate, receive, transmit and final NTP timestamps in order. The timestamp @@ -1240,7 +1240,7 @@ modifications via the .Ar filegen option. It is defined by the -server, usually specified as a compile-time constant. +server, usually specified as a compile\-time constant. It may, however, be configurable for individual file generation sets via other commands. @@ -1306,7 +1306,7 @@ and a day specification in the form .Cm YYYYMMdd . .Cm YYYY -is a 4-digit year number (e.g., 1992). +is a 4\-digit year number (e.g., 1992). .Cm MM is a two digit month number. .Cm dd @@ -1318,21 +1318,21 @@ in a file named .It Cm week Any file set member contains data related to a certain week of a year. -The term week is defined by computing day-of-year +The term week is defined by computing day\-of\-year modulo 7. Elements of such a file generation set are distinguished by appending the following suffix to the file set -filename base: A dot, a 4-digit year number, the letter +filename base: A dot, a 4\-digit year number, the letter .Cm W , -and a 2-digit week number. +and a 2\-digit week number. For example, information from January, 10th 1992 would end up in a file with suffix .No . Ns Ar 1992W1 . .It Cm month One generation file set element is generated per month. The -file name suffix consists of a dot, a 4-digit year number, and -a 2-digit month. +file name suffix consists of a dot, a 4\-digit year number, and +a 2\-digit month. .It Cm year One generation file element is generated per year. The filename @@ -1343,9 +1343,9 @@ the file set every 24 hours of server operation. The filename suffix consists of a dot, the letter .Cm a , -and an 8-digit number. +and an 8\-digit number. This number is taken to be the number of seconds the server is -running at the start of the corresponding 24-hour period. +running at the start of the corresponding 24\-hour period. Information is only written to a file generation by specifying .Cm enable ; output is prevented by specifying @@ -1423,7 +1423,7 @@ an indefinate period. When a client or network is denied access for an indefinate period, the only way at present to remove the restrictions is by restarting the server. -.Ss The Kiss-of-Death Packet +.Ss The Kiss\-of\-Death Packet Ordinarily, packets denied service are simply dropped with no further action except incrementing statistics counters. Sometimes a @@ -1431,9 +1431,9 @@ more proactive response is needed, such as a server message that explicitly requests the client to stop sending and leave a message for the system operator. A special packet format has been created -for this purpose called the "kiss-of-death" (KoD) packet. +for this purpose called the "kiss\-of\-death" (KoD) packet. KoD packets have the leap bits set unsynchronized and stratum set -to zero and the reference identifier field set to a four-byte +to zero and the reference identifier field set to a four\-byte ASCII code. If the .Cm noserve @@ -1476,11 +1476,11 @@ spacing, while the .Cm minimum subcommand specifies the minimum packet spacing. Packets that violate these minima are discarded -and a kiss-o'-death packet returned if enabled. +and a kiss\-o'\-death packet returned if enabled. The default minimum average and minimum are 5 and 2, respectively. The monitor subcommand specifies the probability of discard -for packets that overflow the rate-control window. +for packets that overflow the rate\-control window. .It Xo Ic restrict address .Op Cm mask Ar mask .Op Ar flag ... @@ -1488,13 +1488,13 @@ for packets that overflow the rate-control window. The .Ar address argument expressed in -dotted-quad form is the address of a host or network. +dotted\-quad form is the address of a host or network. Alternatively, the .Ar address argument can be a valid host DNS name. The .Ar mask -argument expressed in dotted-quad form defaults to +argument expressed in dotted\-quad form defaults to .Cm 255.255.255.255 , meaning that the .Ar address @@ -1518,7 +1518,7 @@ in that more restrictive flags will often make less restrictive ones redundant. The flags can generally be classed into two categories, those which restrict time service and those which -restrict informational queries and attempts to do run-time +restrict informational queries and attempts to do run\-time reconfiguration of the server. One or more of the following flags may be specified: @@ -1530,7 +1530,7 @@ and .Xr ntpdc 1ntpdcmdoc queries. .It Cm kod -If this flag is set when an access violation occurs, a kiss-o'-death +If this flag is set when an access violation occurs, a kiss\-o'\-death (KoD) packet is sent. KoD packets are rate limited to no more than one per second. @@ -1599,7 +1599,7 @@ UDP port (123). Both .Cm ntpport and -.Cm non-ntpport +.Cm non\-ntpport may be specified. The @@ -1634,7 +1634,7 @@ of the nearby manycast servers, yet automatically reconfigures to sustain this number of servers should one or another fail. .Pp Note that the manycasting paradigm does not coincide -with the anycast paradigm described in RFC-1546, +with the anycast paradigm described in RFC\-1546, which is designed to find a single server from a clique of servers providing the same service. The manycast paradigm is designed to find a plurality @@ -1663,7 +1663,7 @@ The IANA has designated IPv4 address 224.1.1.1 and IPv6 address FF05::101 (site local) for NTP. When more servers are needed, it broadcasts manycast client messages to this address at the minimum feasible rate -and minimum feasible time-to-live (TTL) hops, depending +and minimum feasible time\-to\-live (TTL) hops, depending on how many servers have already been found. There can be as many manycast client associations as different group address, each one serving as a template @@ -1693,7 +1693,7 @@ Then, the client polls the server at its unicast address in burst mode in order to reliably set the host clock and validate the source. This normally results -in a volley of eight client/server at 2-s intervals +in a volley of eight client/server at 2\-s intervals during which both the synchronization and cryptographic protocols run concurrently. Following the volley, @@ -1706,7 +1706,7 @@ in ordinary client/server mode. .Pp The manycast client polling strategy is designed to reduce as much as possible the volume of manycast client messages -and the effects of implosion due to near-simultaneous +and the effects of implosion due to near\-simultaneous arrival of manycast server messages. The strategy is determined by the .Ic manycastclient , @@ -1872,7 +1872,7 @@ servers will find the servers at the same stratum level. If one of the primary servers loses its GPS receiver, it will continue to operate as a client and other clients will time out the corresponding association and -re-associate accordingly. +re\-associate accordingly. .Pp Some administrators prefer to avoid running .Xr ntpd 1ntpdmdoc @@ -1994,13 +1994,13 @@ a single falseticker. This command specifies a list of TTL values in increasing order, up to 8 values can be specified. In manycast mode these values are used in turn -in an expanding-ring search. +in an expanding\-ring search. The default is eight multiples of 32 starting at 31. .El .Sh Reference Clock Support The NTP Version 4 daemon supports some three dozen different radio, -satellite and modem reference clocks plus a special pseudo-clock +satellite and modem reference clocks plus a special pseudo\-clock used for backup or when no other clock source is available. Detailed descriptions of individual device drivers and options can be found in the @@ -2020,7 +2020,7 @@ provided in .Pa /usr/share/doc/ntp ) . In addition, support for a PPS signal is available as described in the -.Qq Pulse-per-second (PPS) Signal Interfacing +.Qq Pulse\-per\-second (PPS) Signal Interfacing page (available as part of the HTML documentation provided in @@ -2070,7 +2070,7 @@ is an integer denoting the clock type and .Ar u indicates the unit -number in the range 0-3. +number in the range 0\-3. While it may seem overkill, it is in fact sometimes useful to configure multiple reference clocks of the same type, in which case the unit numbers must be unique. @@ -2130,7 +2130,7 @@ and options can be used to override the defaults for the device. There are two optional -device-dependent time offsets and four flags that can be included +device\-dependent time offsets and four flags that can be included in the .Ic fudge command as well. @@ -2147,7 +2147,7 @@ The .Cm stratum option is used for this purpose. Also, in cases -involving both a reference clock and a pulse-per-second (PPS) +involving both a reference clock and a pulse\-per\-second (PPS) discipline signal, it is useful to specify the reference clock identifier as other than the default, depending on the driver. The @@ -2184,7 +2184,7 @@ provided in for further information. .It Cm mode Ar int Specifies a mode number which is interpreted in a -device-specific fashion. +device\-specific fashion. For instance, it selects a dialing protocol in the ACTS driver and a device subtype in the parse @@ -2234,7 +2234,7 @@ follows: .Bl -tag -width indent .It Cm time1 Ar sec Specifies a constant to be added to the time offset produced by -the driver, a fixed-point decimal number in seconds. +the driver, a fixed\-point decimal number in seconds. This is used as a calibration constant to adjust the nominal time offset of a particular clock to agree with an external standard, such as a @@ -2262,8 +2262,8 @@ page provided in .Pa /usr/share/doc/ntp ) . .It Cm time2 Ar secs -Specifies a fixed-point decimal number in seconds, which is -interpreted in a driver-dependent way. +Specifies a fixed\-point decimal number in seconds, which is +interpreted in a driver\-dependent way. See the descriptions of specific drivers in the .Qq Reference Clock Drivers @@ -2284,7 +2284,7 @@ overrides the default identifier ordinarily assigned by the driver itself. .It Cm mode Ar int Specifies a mode number which is interpreted in a -device-specific fashion. +device\-specific fashion. For instance, it selects a dialing protocol in the ACTS driver and a device subtype in the parse @@ -2351,7 +2351,7 @@ frequency of zero. .Pp The file format consists of a single line containing a single floating point number, which records the frequency offset measured -in parts-per-million (PPM). +in parts\-per\-million (PPM). The file is updated by first writing the current drift value into a temporary file and then renaming this file to replace the old version. @@ -2428,7 +2428,7 @@ The default for this flag is .Ic enable . .It Cm pps -Enables the pulse-per-second (PPS) signal when frequency and time is +Enables the pulse\-per\-second (PPS) signal when frequency and time is disciplined by the precision time kernel modifications. See the .Qq A Kernel Model for Precision Timekeeping @@ -2471,7 +2471,7 @@ keywords can be prefixed with .Ql = , .Ql + and -.Ql - , +.Ql \- , where .Ql = sets the @@ -2479,7 +2479,7 @@ sets the priority mask, .Ql + adds and -.Ql - +.Ql \- removes messages. .Xr syslog 3 @@ -2544,7 +2544,7 @@ This command specifies the location of an alternate log file to be used instead of the default system .Xr syslog 3 facility. -This is the same operation as the -l command line option. +This is the same operation as the \-l command line option. .It Ic setvar Ar variable Op Cm default This command adds an additional system variable. These @@ -2624,12 +2624,12 @@ The argument becomes the new value for the dispersion increase rate, normally .000015 s/s. .It Cm freq Ar freq The argument becomes the initial value of the frequency offset in -parts-per-million. +parts\-per\-million. This overrides the value in the frequency file, if present, and avoids the initial training state if it is not. .It Cm huffpuff Ar huffpuff The argument becomes the new value for the experimental -huff-n'-puff filter span, which determines the most recent interval +huff\-n'\-puff filter span, which determines the most recent interval the algorithm will search for a minimum delay. The lower limit is 900 s (15 m), but a more reasonable value is 7200 (2 hours). @@ -2682,10 +2682,49 @@ is started. This command specifies a list of TTL values in increasing order, up to 8 values can be specified. In manycast mode these values are used in turn in -an expanding-ring search. +an expanding\-ring search. The default is eight multiples of 32 starting at 31. .El +.Sh "OPTIONS" +.Bl -tag +.It \-\-help +Display usage information and exit. +.It \-\-more\-help +Pass the extended usage information through a pager. +.It \-\-version "[=\fI{v|c|n}\fP]" +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.El +.Sh "OPTION PRESETS" +Any option that is not marked as \fInot presettable\fP may be preset +by loading values from environment variables named: +.nf + \fBNTP_CONF_\fP or \fBNTP_CONF\fP +.fi +.ad +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 | /usr/local/gnu/bin/grep \-E \-v '^[ ]*$' | $cvt_prog +.Sh "ENVIRONMENT" +See \fBOPTION PRESETS\fP for configuration environment variables. .Sh FILES .Bl -tag -width /etc/ntp.drift -compact .It Pa /etc/ntp.conf @@ -2697,7 +2736,18 @@ RSA private key .It Pa ntpkey_ Ns Ar host RSA public key .It Pa ntp_dh -Diffie-Hellman agreement parameters +Diffie\-Hellman agreement parameters +.El +.Sh "EXIT STATUS" +One of the following exit values will be returned: +.Bl -tag +.It 0 " (EXIT_SUCCESS)" +Successful program execution. +.It 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.It 70 " (EX_SOFTWARE)" +libopts had an internal operational error. Please report +it to autogen\-users@lists.sourceforge.net. Thank you. .El .Sh "SEE ALSO" .Sh SEE ALSO @@ -2719,7 +2769,7 @@ A snapshot of this documentation is available in HTML format in .Sh "AUTHORS" The University of Delaware .Sh "COPYRIGHT" -Copyright (C) 1970-2013 The University of Delaware all rights reserved. +Copyright (C) 1970\-2013 The University of Delaware all rights reserved. This program is released under the terms of the NTP license, . .Sh BUGS The syntax checking is not picky; some combinations of @@ -2733,8 +2783,7 @@ certificates. These should be obtained via secure directory services when they become universally available.Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org .Sh NOTES -This document corresponds to version @VERSION@ of NTP. -This document was derived from FreeBSD. -.Pp -This manual page was \fIAutoGen\fP-erated from the \fBntp.conf\fP +This document corresponds to version 4.2.7p345 of NTP. +This document was derived from FreeBSD..Pp +This manual page was \fIAutoGen\fP\-erated from the \fBntp.conf\fP option definitions. diff --git a/ntpd/ntp.conf.html b/ntpd/ntp.conf.html index 048c1c3e7..09b3e38bd 100644 --- a/ntpd/ntp.conf.html +++ b/ntpd/ntp.conf.html @@ -33,7 +33,7 @@ Up: (dir)

This document describes the configuration file for the NTP Project's ntpd program. -

This document applies to version 4.2.7p344 of ntp.conf. +

This document applies to version 4.2.7p345 of ntp.conf.