Miscellaneous Commands and Options

From: Harlan Stenn Date: Mon, 29 Jun 2015 06:00:52 +0000 (+0000) Subject: html/miscopt.html: Document leapsmearinterval, other cleanup. Harlan Stenn. X-Git-Tag: NTP_4_2_8P3~3^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1e54ac674052951f3b4ada36a5d368fbcdc7c696;p=thirdparty%2Fntp.git html/miscopt.html: Document leapsmearinterval, other cleanup. Harlan Stenn. bk: 5590df149W5vWCipT2x4zWAlWw1GJw --- diff --git a/ChangeLog b/ChangeLog index 3c477f334..f33fb2596 100644 --- a/ChangeLog +++ b/ChangeLog @@ -9,6 +9,7 @@ * README.leapsmear edited. Harlan Stenn. * tests/libntp/msyslog.c: fixed a gcc warning. Tomasz Flendrich. * ntpd/ntp.conf.def: Document DSCP and leapsmearinterval. Harlan Stenn. +* html/miscopt.html: Document leapsmearinterval, other cleanup. Harlan Stenn. --- (4.2.8p3-RC3) 2015/06/27 Released by Harlan Stenn diff --git a/html/miscopt.html b/html/miscopt.html index 14ab27599..ac32419df 100644 --- a/html/miscopt.html +++ b/html/miscopt.html @@ -3,6 +3,7 @@ Miscellaneous Commands and Options + @@ -10,7 +11,7 @@ gif

from Pogo, Walt Kelly

We have three, now looking for more.

Last update: - 28-Feb-2015 12:01 + 29-Jun-2015 05:56 UTC

Related Links

@@ -26,6 +27,8 @@

This command specifies the complete path and name of the file used to record the frequency of the local clock oscillator. This is the same operation as the -f command line option. This command is mutually exclusive with the freq option of the tinker command.

If the file exists, it is read at startup in order to set the initial frequency and then updated once per hour or more with the current frequency computed by the daemon. If the file name is specified, but the file itself does not exist, the starts with an initial frequency of zero and creates the file when writing it for the first time. If this command is not given, the daemon will always start with an initial frequency of zero.

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). 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.

dscp dscp

This command specifies the Differentiated Services Code Point (DSCP) value that is used in sent NTP packets. The default value is 46 for Expedited Forwarding (EF).

Provides a way to enable or disable various system options. Flags not mentioned are unaffected. Note that most of these flags can be modified remotely using ntpq utility program's :config and config-from-file commands. @@ -57,6 +60,8 @@

This command loads the NIST leapseconds file and initializes the leapsecond values for the next leapsecond time, expiration time and TAI offset. The file can be obtained directly from NIST national time servers using ftp as the ASCII file pub/leap-seconds.

The leapfile is scanned when ntpd processes the leapfile directive or when ntpd detects that leapfile has changed. ntpd checks once a day to see if the leapfile has changed.

While not strictly a security function, the Autokey protocol provides means to securely retrieve the current or updated leapsecond values from a server.

leapsmearinterval seconds

This EXPERIMENTAL option is only available if ntpd was built with the --enable-leap-smear option to the configure script. It specifies the interval over which a leap second correction will be applied. Recommended values for this option are between 7200 (2 hours) and 86400 (24 hours). DO NOT USE THIS OPTION ON PUBLIC-ACCESS SERVERS! See http://bugs.ntp.org/2855 for more information.

logconfig configkeyword

This command controls the amount and type of output written to the system syslog facility or the alternate logfile log file. All configkeyword keywords can be prefixed with =, + and -, where = sets the syslogmask, + adds and - removes messages. syslog messages can be controlled in four classes (clock, peer, sys and sync). Within these classes four types of messages can be controlled: informational messages (info), event messages (events), statistics messages (statistics) and status messages (status).

Configuration keywords are formed by concatenating the message class with the event class. The all prefix can be used instead of a message class. A message class may also be followed by the all keyword to enable/disable all messages of the respective message class. By default, logconfig output is set to allsync.

@@ -95,6 +100,18 @@

This command is used in conjunction with the ACTS modem driver (type 18). The arguments consist of a maximum of 10 telephone numbers used to dial USNO, NIST or European time services. The Hayes command ATDT is normally prepended to the number, which can contain other modem control codes as well.

reset [allpeers] [auth] [ctl] [io] [mem] [sys] [timer]

Reset one or more groups of counters maintained by ntpd and exposed by ntpq and ntpdc.

rlimit [memlock Nmegabytes | stacksize N4kPages | filenum Nfiledescriptors]

This command alters certain process storage allocation limits, and is only available on some operating systems. Options are as follows:

memlock Nmegabytes: Specify the number of megabytes of memory that can be allocated. Probably only available under Linux, this option is useful when dropping root (the -i option). The default is 32 megabytes. Setting this to zero will prevent any attemp to lock memory.
stacksize N4kPages: Specifies the maximum size of the process stack on systems with the mlockall() function. Defaults to 50 4k pages (200 4k pages in OpenBSD).
filenum Nfiledescriptors: Specifies the maximum number of file descriptors ntp may have open at the same time. Defaults to system default.

saveconfigdir directory_path

Specify the directory in which to write configuration snapshots requested with ntpq's saveconfig command. If saveconfigdir does not appear in the configuration file, saveconfig requests are rejected by ntpd.

setvar variable [default]

@@ -120,18 +137,6 @@

Specifies the stepout threshold in seconds. The default without this command is 300 s. Since this option also affects the training and startup intervals, it should not be set less than the default. Further details are on the Clock State Machine page.

rlimit [memlock Nmegabytes | stacksize N4kPages | filenum Nfiledescriptors]

This command alters certain process storage allocation limits, and is only available on some operating systems. Options are as follows:

memlock Nmegabytes: Specify the number of megabytes of memory that can be allocated. Probably only available under Linux, this option is useful when dropping root (the -i option). The default is 32 megabytes. Setting this to zero will prevent any attemp to lock memory.
stacksize N4kPages: Specifies the maximum size of the process stack on systems with the mlockall() function. Defaults to 50 4k pages (200 4k pages in OpenBSD).
filenum Nfiledescriptors: Specifies the maximum number of file descriptors ntp may have open at the same time. Defaults to system default.

tos [beacon beacon | ceiling ceiling | cohort {0 | 1} | floor floor | maxclock maxclock | maxdist maxdist | minclock minclock | mindist mindist | minsane minsane | orphan stratum | orphanwait delay]

This command alters certain system variables used by the the clock selection and clustering algorithms. The default values of these variables have been carefully optimized for a wide range of network speeds and reliability expectations. Very rarely is it necessary to change the default values; but, some folks can't resist twisting the knobs. It can be used to select the quality and quantity of peers used to synchronize the system clock and is most useful in dynamic server discovery schemes. The options are as follows:

@@ -170,8 +175,6 @@

The trap receiver will generally log event messages and other information from the server in a log file. While such monitor programs may also request their own trap dynamically, configuring a trap receiver will ensure that no messages are lost when the server is started.

ttl hop ...

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. The default is eight multiples of 32 starting at 31.

dscp dscp

This command specifies the Differentiated Services Code Point (DSCP) value that is used in sent NTP packets. The default value is 46 for Expedited Forwarding (EF).