xref: /freebsd/contrib/ntp/html/miscopt.html (revision 276da39af92f48350aa01091a2b8b3e735217eea)
19c2daa00SOllivier Robert<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
29c2daa00SOllivier Robert<html>
39c2daa00SOllivier Robert<head>
4ea906c41SOllivier Robert<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
52b15cb3dSCy Schubert<title>Miscellaneous Commands and Options</title>
6*276da39aSCy Schubert<!-- Changed by: Harlan Stenn, 29-Jun-2015 -->
79c2daa00SOllivier Robert<link href="scripts/style.css" type="text/css" rel="stylesheet">
89c2daa00SOllivier Robert</head>
99c2daa00SOllivier Robert<body>
102b15cb3dSCy Schubert<h3>Miscellaneous Commands and Options</h3>
119c2daa00SOllivier Robert<img src="pic/boom3.gif" alt="gif" align="left"><a href="http://www.eecis.udel.edu/~mills/pictures.html">from <i>Pogo</i>, Walt Kelly</a>
129c2daa00SOllivier Robert<p>We have three, now looking for more.</p>
132b15cb3dSCy Schubert<p>Last update:
14*276da39aSCy Schubert  <!-- #BeginDate format:En2m -->29-Jun-2015  05:56<!-- #EndDate -->
152b15cb3dSCy Schubert    UTC</p>
169c2daa00SOllivier Robert<br clear="left">
179c2daa00SOllivier Robert<h4>Related Links</h4>
182b15cb3dSCy Schubert<script type="text/javascript" language="javascript" src="scripts/command.txt"></script>
192b15cb3dSCy Schubert<script type="text/javascript" language="javascript" src="scripts/miscopt.txt"></script>
209c2daa00SOllivier Robert<hr>
212b15cb3dSCy Schubert<h4>Commands and Options</h4>
229c2daa00SOllivier Robert<dl>
232b15cb3dSCy Schubert  <dt id="broadcastdelay"><tt>broadcastdelay <i>delay</i></tt></dt>
242b15cb3dSCy Schubert  <dd>In broadcast and multicast modes, means are required   to determine the network delay between the server and client. Ordinarily, this is done automatically by the initial calibration exchanges between the client and server. In some cases, the  exchange might not be possible due to network or server access controls. The value of <em><tt>delay</tt></em> is by default zero, in which case the  exchange is enabled. If <em><tt>delay</tt></em> is greater than zero, it becomes the roundtrip delay (s), as measured by the Unix <tt>ping</tt> program, and the exchange is disabled. </dd>
252b15cb3dSCy Schubert  <dt>&nbsp;</dt>
262b15cb3dSCy Schubert  <dt id="driftfile"><tt>driftfile <i>driftfile</i></tt></dt>
272b15cb3dSCy Schubert  <dd>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 <tt>-f</tt> command line option. This command is mutually exclusive with the <tt>freq</tt> option of the <tt>tinker</tt> command.</dd>
282b15cb3dSCy Schubert  <dd> 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.</dd>
292b15cb3dSCy Schubert  <dd>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.</dd>
30*276da39aSCy Schubert  <dt id="dscp"><tt>dscp <i>dscp</i></tt></dt>
31*276da39aSCy Schubert  <dd>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).</dd>
322b15cb3dSCy Schubert  <dt id="enable"><tt>enable [auth | bclient | calibrate | kernel | mode7 | monitor | ntp | stats]</tt><br>
332b15cb3dSCy Schubert    <tt>disable [auth | bclient | calibrate | kernel | mode7 | monitor | ntp | stats]</tt></dt>
342b15cb3dSCy Schubert  <dd>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 <a href="ntpq.html"><tt>ntpq</tt></a> utility program's <tt>:config</tt> and <tt>config-from-file</tt> commands.
359c2daa00SOllivier Robert    <dl>
362b15cb3dSCy Schubert      <dt><tt>auth</tt></dt>
372b15cb3dSCy Schubert      <dd>Enables the server to synchronize with unconfigured peers only if the peer has been correctly authenticated using either public key or private key cryptography. The default for this flag is enable.</dd>
382b15cb3dSCy Schubert      <dt><tt>bclient</tt></dt>
392b15cb3dSCy Schubert      <dd>Enables the server to listen for a message from a broadcast or multicast server, as in the <tt>multicastclient</tt> command with default address. The default for this flag is disable.</dd>
402b15cb3dSCy Schubert      <dt><tt>calibrate</tt></dt>
412b15cb3dSCy Schubert      <dd>Enables the calibrate feature for reference clocks. The default for this flag is disable.</dd>
422b15cb3dSCy Schubert      <dt><tt>kernel</tt></dt>
432b15cb3dSCy Schubert      <dd>Enables the kernel time discipline, if available. The default for this flag is enable if support is available, otherwise disable.</dd>
442b15cb3dSCy Schubert      <dt><tt>mode7</tt></dt>
452b15cb3dSCy Schubert      <dd>Enables processing of NTP mode 7 implementation-specific requests which are used by the deprecated <tt>ntpdc</tt> program. The default for this flag is disable. This flag is excluded from runtime configuration using <tt>ntpq</tt>. The <tt>ntpq</tt> program provides the same capabilities as <tt>ntpdc</tt> using standard mode 6 requests.</dd>
462b15cb3dSCy Schubert      <dt><tt>monitor</tt></dt>
472b15cb3dSCy Schubert      <dd>Enables the monitoring facility. See the <a href="ntpq.html"><tt>ntpq</tt> program</a> and the <tt>monstats</tt> and <tt>mrulist</tt> commands, as well as the <a href="accopt.html#discard">Access Control Options</a> for details.
482b15cb3dSCy Schubert        The monitoring facility is also enabled by the presence of <a href="accopt.html#limited"><tt>limited</tt></a> in any <tt>restrict</tt> commands. The default for this flag is enable.</dd>
492b15cb3dSCy Schubert      <dt><tt>ntp</tt></dt>
502b15cb3dSCy Schubert      <dd>Enables time and frequency discipline. In effect, this switch opens and closes the feedback loop, which is useful for testing. The default for this flag is enable.</dd>
512b15cb3dSCy Schubert      <dt><tt>stats</tt></dt>
522b15cb3dSCy Schubert      <dd>Enables the statistics facility. See the <a href="monopt.html">Monitoring Options</a> page for further information. The default for this flag is enabled. This flag is excluded from runtime configuration using <tt>ntpq</tt>.</dd>
539c2daa00SOllivier Robert    </dl>
542b15cb3dSCy Schubert  </dd>
552b15cb3dSCy Schubert  <dt id="includefile"><tt>includefile <i>includefile</i></tt></dt>
562b15cb3dSCy Schubert  <dd>This command allows additional configuration commands to be included from a separate file. Include files may be nested to a depth of five; upon reaching the end of any include file, command processing resumes in the previous configuration file. This option is useful for sites that run <tt>ntpd</tt> on multiple hosts, with (mostly) common options (e.g., a restriction list).</dd>
572b15cb3dSCy Schubert  <dt id="interface"><tt>interface [listen | ignore | drop] [all | ipv4 | ipv6 | wildcard | <i>name</i> | <i>address</i>[/<i>prefixlen</i>]]</tt></dt>
582b15cb3dSCy Schubert  <dd>This command controls which network addresses <tt>ntpd</tt> opens, and whether input is dropped without processing. The first parameter determines the action for addresses which match the second parameter. That parameter specifies a class of addresses, or a specific interface name, or an address. In the address case, <tt><i>prefixlen</i></tt> determines how many bits must match for this rule to apply. <tt>ignore</tt> prevents opening matching addresses, <tt>drop</tt> causes <tt>ntpd</tt> to open the address and drop all received packets without examination. Multiple <tt>interface</tt> commands can be used. The last rule which matches a particular address determines the action for it. <tt>interface</tt> commands are disabled if any <a href="ntpd.html#--interface"><tt>-I</tt></a>, <a href="ntpd.html#--interface"><tt>--interface</tt></a>, <a href="ntpd.html#--novirtualips"><tt>-L</tt></a>, or <a href="ntpd.html#--novirtualips"><tt>--novirtualips</tt></a> command-line options are used.  If none of those options are used and no <tt>interface</tt> actions are specified in the configuration file, all available network addresses are opened. The <tt>nic</tt> command is an alias for <tt>interface</tt>.</dd>
592b15cb3dSCy Schubert  <dt id="leapfile"><tt>leapfile <i>leapfile</i></tt></dt>
602b15cb3dSCy Schubert  <dd>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 <tt>ftp</tt> as the ASCII file <tt>pub/leap-seconds</tt>.</dd>
612b15cb3dSCy Schubert  <dd>The <i>leapfile</i> is scanned when <tt>ntpd</tt> processes the <tt>leapfile</tt> directive or when <tt>ntpd</tt> detects that <i>leapfile</i> has changed.  <tt>ntpd</tt> checks once a day to see if the <i>leapfile</i> has changed.</dd>
622b15cb3dSCy Schubert  <dd>While not strictly a security function, the Autokey protocol provides means to securely retrieve the current or updated leapsecond values from a server.</dd>
63*276da39aSCy Schubert  <dt id="leapsmearinterval"><tt>leapsmearinterval <i>seconds</i></tt></dt>
64*276da39aSCy Schubert  <dd>This EXPERIMENTAL option is only available if <tt>ntpd</tt> was built with the <tt>--enable-leap-smear</tt> option to the <tt>configure</tt> 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).  <b>DO NOT USE THIS OPTION ON PUBLIC-ACCESS SERVERS!</b>  See http://bugs.ntp.org/2855 for more information.</dd>
652b15cb3dSCy Schubert  <dt id="logconfig"><tt>logconfig <i>configkeyword</i></tt></dt>
662b15cb3dSCy Schubert  <dd>This command controls the amount and type of output written to the system <tt>syslog</tt> facility or the alternate <tt>logfile</tt> log file. All <i><tt>configkeyword</tt></i> keywords can be prefixed with <tt>=</tt>, <tt>+</tt> and <tt>-</tt>, where <tt>=</tt> sets the <tt>syslogmask</tt>, <tt>+</tt> adds and <tt>-</tt> removes messages. <tt>syslog messages</tt> can be controlled in four classes (<tt>clock</tt>, <tt>peer</tt>, <tt>sys</tt> and <tt>sync</tt>). Within these classes four types of messages can be controlled: informational messages (<tt>info</tt>), event messages (<tt>events</tt>), statistics messages (<tt>statistics</tt>) and status messages (<tt>status</tt>).</dd>
672b15cb3dSCy Schubert  <dd>Configuration keywords are formed by concatenating the message class with the event class. The <tt>all</tt> prefix can be used instead of a message class. A message class may also be followed by the <tt>all</tt> keyword to enable/disable all messages of the respective message class. By default, <tt>logconfig</tt> output is set to <tt>allsync</tt>.</dd>
682b15cb3dSCy Schubert  <dd>Thus, a minimal log configuration could look like this:</dd>
692b15cb3dSCy Schubert  <dd><tt>logconfig=syncstatus +sysevents</tt></dd>
702b15cb3dSCy Schubert  <dd>This would just list the synchronizations state of <tt>ntpd</tt> and the major system events. For a simple reference server, the following minimum message configuration could be useful:</dd>
712b15cb3dSCy Schubert  <dd><tt>logconfig=syncall +clockall</tt></dd>
722b15cb3dSCy Schubert  <dd>This configuration will list all clock information and synchronization information. All other events and messages about peers, system events and so on is suppressed.</dd>
732b15cb3dSCy Schubert  <dt id="logfile"><tt>logfile <i>logfile</i></tt></dt>
742b15cb3dSCy Schubert  <dd>This command specifies the location of an alternate log file to be used instead of the default system <tt>syslog</tt> facility. This is the same operation as the <tt>-l </tt>command line option.</dd>
752b15cb3dSCy Schubert  <dt id="mru"><tt>mru [maxdepth <i>count</i> | maxmem <i>kilobytes</i> | mindepth <i>count</i> | maxage <i>seconds</i> | initalloc <i>count</i> | initmem <i>kilobytes</i> | incalloc <i>count</i> | incmem <i>kilobytes</i>]</tt></dt>
762b15cb3dSCy Schubert  <dd>Controls size limits of the monitoring facility Most Recently Used <a href="ntpq.html#mrulist">(MRU) list</a> of client addresses, which is also used by the <a href="accopt.html#discard">rate control facility</a>.
77ea906c41SOllivier Robert    <dl>
782b15cb3dSCy Schubert      <dt><tt>maxdepth <i>count</i><br>
792b15cb3dSCy Schubert        maxmem <i>kilobytes</i></tt></dt>
802b15cb3dSCy Schubert      <dd>Equivalent upper limits on the size of the MRU list, in terms of entries or kilobytes. The actual limit will be up to <tt>incalloc</tt> entries or <tt>incmem</tt> kilobytes larger. As with all
812b15cb3dSCy Schubert        of the <tt>mru</tt> options offered in units of entries or kilobytes, if both <tt>maxdepth</tt> and <tt>maxmem</tt> are used, the last one used controls. The default is 1024 kilobytes.</dd>
822b15cb3dSCy Schubert      <dt><tt>mindepth <i>count</i></tt></dt>
832b15cb3dSCy Schubert      <dd>Lower limit on the MRU list size. When the MRU list has fewer than <tt>mindepth</tt> entries, existing entries are never removed to make room for newer ones, regardless of their age.
842b15cb3dSCy Schubert        The default is 600 entries.</dd>
852b15cb3dSCy Schubert      <dt><tt>maxage <i>seconds</i></tt></dt>
862b15cb3dSCy Schubert      <dd>Once the MRU list has <tt>mindepth</tt> entries and an additional client address is to be added to the list, if the oldest entry was updated more than <tt>maxage</tt> seconds ago, that entry
872b15cb3dSCy Schubert        is removed and its storage reused. If the oldest entry was updated more recently, the MRU list
882b15cb3dSCy Schubert        is grown, subject to <tt>maxdepth</tt>/<tt>maxmem</tt>. The default is 64 seconds.</dd>
892b15cb3dSCy Schubert      <dt><tt>initalloc <i>count</i><br>
902b15cb3dSCy Schubert        initmem <i>kilobytes</i></tt></dt>
912b15cb3dSCy Schubert      <dd>Initial memory allocation at the time the monitoring facility is first enabled, in terms of entries or kilobytes.  The default is 4 kilobytes.</dd>
922b15cb3dSCy Schubert      <dt><tt>incalloc <i>count</i><br>
932b15cb3dSCy Schubert        incmem <i>kilobytes</i></tt></dt>
942b15cb3dSCy Schubert      <dd>Size of additional memory allocations when growing the MRU list, in entries or kilobytes. The default is 4 kilobytes.</dd>
952b15cb3dSCy Schubert    </dl>
962b15cb3dSCy Schubert  </dd>
972b15cb3dSCy Schubert  <dt id="nonvolatile"><tt>nonvolatile <i>threshold</i></tt></dt>
98a25439b6SCy Schubert  <dd>Specify the <i><tt>threshold</tt></i> in seconds to write the frequency file, with default of 1e-7 (0.1 PPM). The frequency file is inspected each hour. If the difference between the current frequency  and the last value written exceeds the threshold, the file is written and the <tt><em>threshold</em></tt>  becomes the new threshold value. If the threshold is not exceeded, it is reduced by half. This is intended to reduce the frequency of unnecessary file writes for embedded systems with nonvolatile memory.</dd>
992b15cb3dSCy Schubert  <dt id="phone"><tt>phone <i>dial</i> ...</tt></dt>
1002b15cb3dSCy Schubert  <dd>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&nbsp;is normally prepended to the number, which can contain other modem control codes as well.</dd>
1012b15cb3dSCy Schubert  <dt id="reset"><tt>reset [allpeers] [auth] [ctl] [io] [mem] [sys] [timer]</tt></dt>
1022b15cb3dSCy Schubert  <dd>Reset one or more groups of counters maintained by ntpd and exposed by <tt>ntpq</tt> and <tt>ntpdc</tt>.</dd>
103*276da39aSCy Schubert  <dt id="rlimit"><tt>rlimit [memlock <i>Nmegabytes</i> | stacksize <i>N4kPages</i> | filenum <i>Nfiledescriptors</i>]</tt></dt>
104*276da39aSCy Schubert  <dd>This command alters certain process storage allocation limits, and is only available on some operating systems.  Options are as follows:</dd>
105*276da39aSCy Schubert  <dd>
106*276da39aSCy Schubert    <dl>
107*276da39aSCy Schubert      <dt><tt>memlock <i>Nmegabytes</i></tt></dt>
108*276da39aSCy Schubert      <dd>Specify the number of megabytes of memory that can be allocated.  Probably only available under Linux, this option is useful when dropping root (the <tt>-i</tt> option).   The default is 32  megabytes. Setting this to zero will prevent any attemp to lock memory.</dd>
109*276da39aSCy Schubert      <dt><tt>stacksize <i>N4kPages</i></tt></dt>
110*276da39aSCy Schubert      <dd>Specifies the maximum size of the process stack on systems with the <tt>mlockall()</tt> function. Defaults to 50 4k pages (200 4k pages in OpenBSD).</dd>
111*276da39aSCy Schubert      <dt><tt>filenum <i>Nfiledescriptors</i></tt></dt>
112*276da39aSCy Schubert      <dd>Specifies the maximum number of file descriptors ntp may have open at the same time. Defaults to system default.</dd>
113*276da39aSCy Schubert    </dl>
114*276da39aSCy Schubert  </dd>
1152b15cb3dSCy Schubert  <dt id="saveconfigdir"><tt>saveconfigdir <i>directory_path</i></tt></dt>
1162b15cb3dSCy Schubert  <dd>Specify the directory in which to write configuration snapshots requested with <tt>ntpq</tt>'s <a href="ntpq.html#saveconfig">saveconfig</a> command.  If <tt>saveconfigdir</tt> does not appear in the configuration file, saveconfig requests are rejected by ntpd.</dd>
1172b15cb3dSCy Schubert  <dt id="setvar"><tt>setvar <i>variable</i> [default]</tt></dt>
1182b15cb3dSCy Schubert  <dd>This command adds an additional system variable. These variables can be used to distribute additional information such as the access policy. If the variable of the form <tt><i>name</i> = <i>value</i></tt> is followed by the <tt>default</tt> keyword, the variable will be listed as part of the default system variables (<tt>ntpq rv</tt> command). These additional variables serve informational purposes only. They are not related to the protocol other that they can be listed. The known protocol variables will always override any variables defined via the <tt>setvar</tt> mechanism. There are three special variables that contain the names of all variable of the same group. The <tt>sys_var_list</tt> holds the names of all system variables. The <tt>peer_var_list</tt> holds the names of all peer variables and the <tt>clock_var_list</tt> holds the names of the reference clock variables.</dd>
1192b15cb3dSCy Schubert  <dt id="tinker"><tt>tinker [allan <i>allan</i> | dispersion <i>dispersion</i> | freq <i>freq</i> | huffpuff <i>huffpuff</i> | panic <i>panic</i> | step <i>step</i> | stepout <i>stepout</i>]</tt></dt>
1202b15cb3dSCy Schubert  <dd>This command alters certain system variables used by the clock discipline algorithm. 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. Options are as follows:</dd>
121ea906c41SOllivier Robert  <dd>
1222b15cb3dSCy Schubert    <dl>
1232b15cb3dSCy Schubert      <dt><tt>allan <i>allan</i></tt></dt>
1242b15cb3dSCy Schubert      <dd>Specifies the Allan intercept, which is a parameter of the PLL/FLL clock discipline algorithm, in seconds with default 1500 s.</dd>
1252b15cb3dSCy Schubert      <dt><tt>dispersion <i>dispersion</i></tt></dt>
1262b15cb3dSCy Schubert      <dd>Specifies the dispersion increase rate in parts-per-million (PPM) with default 15 PPM.</dd>
1272b15cb3dSCy Schubert      <dt><tt>freq <i>freq</i></tt></dt>
1282b15cb3dSCy Schubert      <dd>Specifies the frequency offset in parts-per-million (PPM). This option is mutually exclusive with the driftfile command.</dd>
1292b15cb3dSCy Schubert      <dt><tt>huffpuff <i>huffpuff</i></tt></dt>
1302b15cb3dSCy Schubert      <dd>Specifies the 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 min), but a more reasonable value is 7200 (2 hours).See the <a href="huffpuff.html">Huff-n'-Puff Filter</a> page for further information.</dd>
1312b15cb3dSCy Schubert      <dt><tt>panic <i>panic</i></tt></dt>
1322b15cb3dSCy Schubert      <dd>Specifies the panic threshold in seconds with default 1000 s. If set to zero, the panic sanity check is disabled and a clock offset of any value will be accepted.</dd>
1332b15cb3dSCy Schubert      <dt><tt>step <i>step</i></tt></dt>
1342b15cb3dSCy Schubert      <dd>Specifies the step threshold in seconds. The default without this command is 0.128 s. If set to zero, step adjustments will never occur. Note: The kernel time discipline is disabled if the step threshold is set to zero or greater than 0.5
1352b15cb3dSCy Schubert        s. Further details are on the <a href="clock.html">Clock State Machine</a> page.</dd>
1362b15cb3dSCy Schubert      <dt><tt>stepout <i>stepout</i></tt></dt>
1372b15cb3dSCy Schubert      <dd>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 <a href="clock.html">Clock State Machine</a> page.</dd>
138ea906c41SOllivier Robert    </dl>
1392b15cb3dSCy Schubert  </dd>
1402b15cb3dSCy Schubert  <dt id="tos"><tt>tos [beacon <i>beacon</i> | ceiling <i>ceiling</i> | cohort {0 | 1} | floor <i>floor</i> | maxclock <i>maxclock </i>| maxdist <i>maxdist</i> | minclock <i>minclock</i> | mindist <i>mindist </i>| minsane <i>minsane</i> | orphan <i>stratum</i> | orphanwait <em>delay</em>]</tt></dt>
1412b15cb3dSCy Schubert  <dd>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:</dd>
142ea906c41SOllivier Robert  <dd>
143ea906c41SOllivier Robert    <dl>
1442b15cb3dSCy Schubert      <dt><tt>beacon <i>beacon</i></tt></dt>
1452b15cb3dSCy Schubert      <dd>The manycast server sends packets at intervals of 64 s if less than <tt>maxclock</tt> servers are available. Otherwise, it sends packets at the <i><tt>beacon</tt></i> interval in seconds. The default is 3600 s. See the <a href="discover.html">Automatic Server Discovery</a> page for further details.</dd>
1462b15cb3dSCy Schubert      <dt><tt>ceiling <i>ceiling</i></tt></dt>
1472b15cb3dSCy Schubert      <dd>Specify the maximum stratum (exclusive) for acceptable server packets. The default is 16. See the <a href="discover.html">Automatic Server Discovery</a> page for further details.</dd>
1482b15cb3dSCy Schubert      <dt><tt>cohort { 0 | 1 }</tt></dt>
1492b15cb3dSCy Schubert      <dd>Specify whether (1) or whether not (0) a server packet will be accepted for the same stratum as the client. The default is 0. See the <a href="discover.html">Automatic Server Discovery</a> page for further details.</dd>
1502b15cb3dSCy Schubert      <dt><tt>floor <i>floor</i></tt></dt>
1512b15cb3dSCy Schubert      <dd>Specify the minimum stratum (inclusive) for acceptable server packets. The default is 1. See the <a href="discover.html">Automatic Server Discovery</a> page for further details.</dd>
1522b15cb3dSCy Schubert      <dt><tt>maxclock <i>maxclock</i></tt></dt>
1532b15cb3dSCy Schubert      <dd>Specify the maximum number of servers retained by the server discovery schemes. The default is 10. See the <a href="discover.html">Automatic Server Discovery</a> page for further details.</dd>
1542b15cb3dSCy Schubert      <dt><tt>maxdist <i>maxdistance</i></tt></dt>
1552b15cb3dSCy Schubert      <dd>Specify the synchronization distance threshold used by the clock selection algorithm. The default is 1.5 s. This determines both the minimum number of packets to set the system clock and the maximum roundtrip delay. It can be decreased to improve reliability or increased to synchronize clocks on the Moon or planets.</dd>
1562b15cb3dSCy Schubert      <dt><tt>minclock <i>minclock</i></tt></dt>
1572b15cb3dSCy Schubert      <dd>Specify the number of servers used by the clustering algorithm as the minimum to include on the candidate list. The default is 3. This is also the number of servers to be averaged by the combining algorithm.</dd>
1582b15cb3dSCy Schubert      <dt><tt>mindist <i>mindistance</i></tt></dt>
1592b15cb3dSCy Schubert      <dd>Specify the minimum distance used by the selection and anticlockhop
1602b15cb3dSCy Schubert        algorithm. Larger values increase the tolerance for outliers;
1612b15cb3dSCy Schubert        smaller values increase the selectivity. The default is .001 s. In some
1622b15cb3dSCy Schubert        cases, such as reference clocks with high jitter and a PPS signal, it is
1632b15cb3dSCy Schubert        useful to increase the value to insure the intersection interval is
1642b15cb3dSCy Schubert        always nonempty.</dd>
1652b15cb3dSCy Schubert      <dt><tt>minsane <i>minsane</i></tt></dt>
1662b15cb3dSCy Schubert      <dd>Specify the number of servers used by the selection algorithm as the minimum to set the system clock. The default is 1 for legacy purposes; however, for critical applications the value should be somewhat higher but less than <tt>minclock</tt>.</dd>
1672b15cb3dSCy Schubert      <dt><tt>orphan <i>stratum</i></tt></dt>
1682b15cb3dSCy Schubert      <dd>Specify the orphan stratum with default 16. If less than 16 this is the stratum assumed by the root servers. See the <a href="orphan.html">Orphan Mode</a> page for further details.</dd>
1692b15cb3dSCy Schubert      <dt><tt>orphanwait <em>delay</em></tt></dt>
1702b15cb3dSCy Schubert      <dd>Specify the delay in seconds from the time all sources are lost until orphan parent mode is enabled with default 300 s (five minutes). During this period, the local clock driver and the modem driver are not selectable, unless marked with the <tt>prefer</tt> keyword. This allows time for one or more primary sources to become reachable and selectable before using backup sources, and avoids transient use of the backup sources at startup.</dd>
171ea906c41SOllivier Robert    </dl>
1722b15cb3dSCy Schubert  </dd>
1732b15cb3dSCy Schubert  <dt id="trap"><tt>trap <i>host_address</i> [port <i>port_number</i>] [interface <i>interfSace_address</i>]</tt></dt>
1742b15cb3dSCy Schubert  <dd>This command configures a trap receiver at the given host address and port number for sending messages with the specified local interface address. If the port number is unspecified, a value of 18447 is used. If the interface address is not specified, the message is sent with a source address of the local interface the message is sent through. Note that on a multihomed host the interface used may vary from time to time with routing changes.</dd>
1752b15cb3dSCy Schubert  <dd>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.</dd>
1762b15cb3dSCy Schubert  <dt id="ttl"><tt>ttl <i>hop</i> ...</tt></dt>
1772b15cb3dSCy Schubert  <dd>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.</dd>
178ea906c41SOllivier Robert</dl>
1799c2daa00SOllivier Robert<hr>
1809c2daa00SOllivier Robert<script type="text/javascript" language="javascript" src="scripts/footer.txt"></script>
1819c2daa00SOllivier Robert</body>
1829c2daa00SOllivier Robert</html>
183