ntpd.html revision 301256
12966Swollman<html lang="en">
250477Speter<head>
31590Srgrimes<title>ntpd: Network Time Protocol (NTP) Daemon User's Manual</title>
4156813Sru<meta http-equiv="Content-Type" content="text/html">
5156813Sru<meta name="description" content="ntpd: Network Time Protocol (NTP) Daemon User's Manual">
64699Sjkh<meta name="generator" content="makeinfo 4.7">
734706Sbde<link title="Top" rel="top" href="#Top">
897128Sjmallett<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
91930Swollman<meta http-equiv="Content-Style-Type" content="text/css">
101930Swollman<style type="text/css"><!--
11106717Smarcel  pre.display { font-family:inherit }
12100200Swollman  pre.format  { font-family:inherit }
13100200Swollman  pre.smalldisplay { font-family:inherit; font-size:smaller }
14176457Sru  pre.smallformat  { font-family:inherit; font-size:smaller }
1596630Stjr  pre.smallexample { font-size:smaller }
16183242Ssam  pre.smalllisp    { font-size:smaller }
17121666Sharti  span.sc { font-variant:small-caps }
1891706Sobrien  span.roman { font-family: serif; font-weight: normal; } 
1938653Sgpalmer--></style>
2038653Sgpalmer</head>
21202892Santoine<body>
22183242Ssam<h1 class="settitle">ntpd: Network Time Protocol (NTP) Daemon User's Manual</h1>
23124587Sru<div class="node">
2457013Sobrien<p><hr>
25148771Scperciva<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-Description">ntpd Description</a>,
2678562SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
27108667SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
28119553Sphk<br>
29119553Sphk</div>
30148677Sphk
3138653Sgpalmer<h2 class="unnumbered">ntpd: Network Time Protocol (NTP) Daemon User Manual</h2>
32148741Sphk
3338653Sgpalmer<p>The <code>ntpd</code> program is an operating system daemon that synchronizes the
34183242Ssamsystem clock to remote NTP time servers or local reference clocks. 
35124587SruIt is a complete implementation of NTP version 4 defined by RFC-5905, but
3638653Sgpalmeralso retains compatible with version 3 defined by RFC-1305 and versions
3738653Sgpalmer1 and 2, defined by RFC-1059 and RFC-1119, respectively. 
3838653SgpalmerThe program can operate in any of several modes, including client/server,
3938653Sgpalmersymmetric and broadcast modes, and with both symmetric-key and public-key
40183242Ssamcryptography.
4138653Sgpalmer
4238653Sgpalmer  <p>This document applies to version 4.2.8p8 of <code>ntpd</code>.
4338653Sgpalmer
4438653Sgpalmer<ul class="menu">
45183242Ssam<li><a accesskey="1" href="#ntpd-Description">ntpd Description</a>:             Description
4638653Sgpalmer<li><a accesskey="2" href="#ntpd-Invocation">ntpd Invocation</a>: 		Invoking ntpd
47179813Sdougb<li><a accesskey="3" href="#Usage">Usage</a>:                        Usage
48176733Sjeff</ul>
4995926Stjr
50156256Smux<div class="node">
51183242Ssam<p><hr>
5238653Sgpalmer<a name="ntpd-Description"></a>
53202892Santoine<br>
54124587Sru</div>
5538653Sgpalmer
5638653Sgpalmer<!-- node-name,  next,  previous,  up -->
5738653Sgpalmer<h3 class="section">Description</h3>
58108439Sobrien
59109314Sobrien<p>The <code>ntpd</code> program ordinarily requires
6040826Sjoerga configuration file described at <a href="#ntp_002econf">ntp.conf</a>. 
6138653SgpalmerThis configuration file contains configuration commands described on
6238653Sgpalmerthe pages listed above. 
6338653SgpalmerHowever a client can discover remote servers and configure them
6438653Sgpalmerautomatically. 
6538653SgpalmerThis makes it possible to deploy a fleet of workstations without
66183242Ssamspecifying configuration details specific to the local environment.
6738653Sgpalmer
6838653Sgpalmer  <p>The <code>ntpd</code> program normally operates continuously while adjusting the
69203711Sdelphijsystem time and frequency, but in some cases this might not be
7038653Sgpalmerpractical. 
71183242SsamWith the <code>-q</code> option <code>ntpd</code> operates as in continuous mode, but
7241036Sdimaexits just after setting the clock for the first time. 
7363499SpsMost applications will probably want to specify the <code>iburst</code>
7438653Sgpalmeroption with the <code>server</code> command. 
75103303SpeterWith this option an initial volley of messages is exchanged to
7638653Sgpalmergroom the data and set the clock in about ten seconds' time. 
77101629SjakeIf nothing is heard after a few minutes' time,
78158287Smaximthe daemon times out and exits without setting the clock.
7938653Sgpalmer
80111204Sobrien<div class="node">
81166255Sdelphij<p><hr>
8238653Sgpalmer<a name="ntpd-Invocation"></a>
83148780Sphk<br>
8438653Sgpalmer</div>
85124587Sru
8638653Sgpalmer<h3 class="section">Invoking ntpd</h3>
87183242Ssam
8838653Sgpalmer<p><a name="index-ntpd-1"></a><a name="index-NTP-daemon-program-2"></a>
8938653Sgpalmer
9038653Sgpalmer  <p>The
9138653Sgpalmer<code>ntpd</code>
9238653Sgpalmerutility is an operating system daemon which sets
9338653Sgpalmerand maintains the system time of day in synchronism with Internet
9438653Sgpalmerstandard time servers. 
9538653SgpalmerIt is a complete implementation of the
9638653SgpalmerNetwork Time Protocol (NTP) version 4, as defined by RFC-5905,
9793619Sjakebut also retains compatibility with
9838653Sgpalmerversion 3, as defined by RFC-1305, and versions 1
9938653Sgpalmerand 2, as defined by RFC-1059 and RFC-1119, respectively.
10038653Sgpalmer
10139614Sbde  <p>The
10238653Sgpalmer<code>ntpd</code>
10360789Spsutility does most computations in 64-bit floating point
10460789Spsarithmetic and does relatively clumsy 64-bit fixed point operations
10560789Spsonly when necessary to preserve the ultimate precision, about 232
106119553Sphkpicoseconds. 
10738653SgpalmerWhile the ultimate precision is not achievable with
108116677Sphantomordinary workstations and networks of today, it may be required
109183242Ssamwith future gigahertz CPU clocks and gigabit LANs.
11038653Sgpalmer
11138653Sgpalmer  <p>Ordinarily,
11238653Sgpalmer<code>ntpd</code>
11338653Sgpalmerreads the
114126701Sdes<code>ntp.conf(5)</code>
11538653Sgpalmerconfiguration file at startup time in order to determine the
11638653Sgpalmersynchronization sources and operating modes. 
11738653SgpalmerIt is also possible to
11838653Sgpalmerspecify a working, although limited, configuration entirely on the
11938653Sgpalmercommand line, obviating the need for a configuration file. 
120183242SsamThis may
121183242Ssambe particularly useful when the local host is to be configured as a
12296845Smarkmbroadcast/multicast client, with all peers being determined by
12338653Sgpalmerlistening to broadcasts at run time.
124174814Sru
125174810Sphk  <p>If NetInfo support is built into
12638653Sgpalmer<code>ntpd</code>
12738653Sgpalmerthen
12838653Sgpalmer<code>ntpd</code>
129183242Ssamwill attempt to read its configuration from the
13038653SgpalmerNetInfo if the default
131146107Sfjoe<code>ntp.conf(5)</code>
132183242Ssamfile cannot be read and no file is
13339914Sdfrspecified by the
134141800Sdelphij<code>-c</code>
13538653Sgpalmeroption.
136124587Sru
137124587Sru  <p>Various internal
13838653Sgpalmer<code>ntpd</code>
13997365Stjrvariables can be displayed and
140124587Sruconfiguration options altered while the
14138653Sgpalmer<code>ntpd</code>
14238653Sgpalmeris running
14376273Sbrianusing the
14438653Sgpalmer<code>ntpq(1ntpqmdoc)</code>
145135549Sdesand
146135549Sdes<code>ntpdc(1ntpdcmdoc)</code>
14738653Sgpalmerutility programs.
14838653Sgpalmer
14938653Sgpalmer  <p>When
15038653Sgpalmer<code>ntpd</code>
15138653Sgpalmerstarts it looks at the value of
15238653Sgpalmer<code>umask(2)</code>,
15397096Stjrand if zero
154192398Sgnn<code>ntpd</code>
15538653Sgpalmerwill set the
15638653Sgpalmer<code>umask(2)</code>
15738653Sgpalmerto 022.
158174200Srwatson
159183242Ssam  <p>This section was generated by <strong>AutoGen</strong>,
16038653Sgpalmerusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpd</code> program. 
16138653SgpalmerThis software is released under the NTP license, &lt;http://ntp.org/license>;.
162194267Sed
163143026Strhodes<ul class="menu">
164183242Ssam<li><a accesskey="1" href="#ntpd-usage">ntpd usage</a>:                   ntpd help/usage (<span class="option">--help</span>)
16538653Sgpalmer<li><a accesskey="2" href="#ntpd-ipv4">ntpd ipv4</a>:                    ipv4 option (-4)
16638653Sgpalmer<li><a accesskey="3" href="#ntpd-ipv6">ntpd ipv6</a>:                    ipv6 option (-6)
167143026Strhodes<li><a accesskey="4" href="#ntpd-authreq">ntpd authreq</a>:                 authreq option (-a)
16838653Sgpalmer<li><a accesskey="5" href="#ntpd-authnoreq">ntpd authnoreq</a>:               authnoreq option (-A)
169183242Ssam<li><a accesskey="6" href="#ntpd-configfile">ntpd configfile</a>:              configfile option (-c)
17038653Sgpalmer<li><a accesskey="7" href="#ntpd-driftfile">ntpd driftfile</a>:               driftfile option (-f)
17138653Sgpalmer<li><a accesskey="8" href="#ntpd-panicgate">ntpd panicgate</a>:               panicgate option (-g)
172183242Ssam<li><a accesskey="9" href="#ntpd-force_002dstep_002donce">ntpd force-step-once</a>:         force-step-once option (-G)
17338653Sgpalmer<li><a href="#ntpd-jaildir">ntpd jaildir</a>:                 jaildir option (-i)
17438653Sgpalmer<li><a href="#ntpd-interface">ntpd interface</a>:               interface option (-I)
17538653Sgpalmer<li><a href="#ntpd-keyfile">ntpd keyfile</a>:                 keyfile option (-k)
17638653Sgpalmer<li><a href="#ntpd-logfile">ntpd logfile</a>:                 logfile option (-l)
177124587Sru<li><a href="#ntpd-novirtualips">ntpd novirtualips</a>:            novirtualips option (-L)
17845701Sdes<li><a href="#ntpd-modifymmtimer">ntpd modifymmtimer</a>:           modifymmtimer option (-M)
17938653Sgpalmer<li><a href="#ntpd-nice">ntpd nice</a>:                    nice option (-N)
18097955Sdougb<li><a href="#ntpd-pidfile">ntpd pidfile</a>:                 pidfile option (-p)
18138653Sgpalmer<li><a href="#ntpd-priority">ntpd priority</a>:                priority option (-P)
18241035Sdima<li><a href="#ntpd-quit">ntpd quit</a>:                    quit option (-q)
18397034Stjr<li><a href="#ntpd-propagationdelay">ntpd propagationdelay</a>:        propagationdelay option (-r)
18438653Sgpalmer<li><a href="#ntpd-saveconfigquit">ntpd saveconfigquit</a>:          saveconfigquit option
18538653Sgpalmer<li><a href="#ntpd-statsdir">ntpd statsdir</a>:                statsdir option (-s)
186127947Skientzle<li><a href="#ntpd-trustedkey">ntpd trustedkey</a>:              trustedkey option (-t)
18738653Sgpalmer<li><a href="#ntpd-user">ntpd user</a>:                    user option (-u)
18838653Sgpalmer<li><a href="#ntpd-updateinterval">ntpd updateinterval</a>:          updateinterval option (-U)
189183242Ssam<li><a href="#ntpd-wait_002dsync">ntpd wait-sync</a>:               wait-sync option (-w)
19038653Sgpalmer<li><a href="#ntpd-slew">ntpd slew</a>:                    slew option (-x)
19138653Sgpalmer<li><a href="#ntpd-usepcc">ntpd usepcc</a>:                  usepcc option
19288277Smarkm<li><a href="#ntpd-pccfreq">ntpd pccfreq</a>:                 pccfreq option
19338653Sgpalmer<li><a href="#ntpd-mdns">ntpd mdns</a>:                    mdns option (-m)
19438653Sgpalmer<li><a href="#ntpd-config">ntpd config</a>:                  presetting/configuring ntpd
19538653Sgpalmer<li><a href="#ntpd-exit-status">ntpd exit status</a>:             exit status
19638653Sgpalmer<li><a href="#ntpd-Usage">ntpd Usage</a>:                   Usage
19738653Sgpalmer<li><a href="#ntpd-Files">ntpd Files</a>:                   Files
19863437Ssheldonh<li><a href="#ntpd-See-Also">ntpd See Also</a>:                See Also
199111204Sobrien<li><a href="#ntpd-Bugs">ntpd Bugs</a>:                    Bugs
20038653Sgpalmer<li><a href="#ntpd-Notes">ntpd Notes</a>:                   Notes
20138653Sgpalmer</ul>
20238653Sgpalmer
203183242Ssam<div class="node">
20438653Sgpalmer<p><hr>
20538653Sgpalmer<a name="ntpd-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-ipv4">ntpd ipv4</a>,
206183242SsamUp:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
20738653Sgpalmer<br>
208200068Srdivacky</div>
20938653Sgpalmer
21038653Sgpalmer<h4 class="subsection">ntpd help/usage (<span class="option">--help</span>)</h4>
211124587Sru
212124587Sru<p><a name="index-ntpd-help-3"></a>
21338653SgpalmerThis is the automatically generated usage text for ntpd.
21438653Sgpalmer
21538653Sgpalmer  <p>The text printed is the same whether selected with the <code>help</code> option
216124587Sru(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
217183242Ssamthe usage text by passing it through a pager program. 
21838653Sgpalmer<code>more-help</code> is disabled on platforms without a working
21938653Sgpalmer<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
22041062Sbdeused to select the program, defaulting to <span class="file">more</span>.  Both will exit
22138653Sgpalmerwith a status code of 0.
22238653Sgpalmer
22338653Sgpalmer<pre class="example">ntpd - NTP daemon program - Ver. 4.2.8p7
22438653SgpalmerUsage:  ntpd [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]... \
22599379Sjohan                [ &lt;server1&gt; ... &lt;serverN&gt; ]
22638653Sgpalmer  Flg Arg Option-Name    Description
22738653Sgpalmer   -4 no  ipv4           Force IPv4 DNS name resolution
22838653Sgpalmer                                - prohibits the option 'ipv6'
22938653Sgpalmer   -6 no  ipv6           Force IPv6 DNS name resolution
230202301Sed                                - prohibits the option 'ipv4'
23138653Sgpalmer   -a no  authreq        Require crypto authentication
23238653Sgpalmer                                - prohibits the option 'authnoreq'
233106717Smarcel   -A no  authnoreq      Do not require crypto authentication
234183242Ssam                                - prohibits the option 'authreq'
235119553Sphk   -b no  bcastsync      Allow us to sync to broadcast servers
23638653Sgpalmer   -c Str configfile     configuration file name
237137675Sbz   -d no  debug-level    Increase debug verbosity level
238137675Sbz                                - may appear multiple times
239137675Sbz   -D Num set-debug-level Set the debug verbosity level
2401590Srgrimes                                - may appear multiple times
241188629Simp   -f Str driftfile      frequency drift file name
242124587Sru   -g no  panicgate      Allow the first adjustment to be Big
243124587Sru                                - may appear multiple times
244124587Sru   -G no  force-step-once Step any initial offset correction.
245183242Ssam   -i Str jaildir        Jail directory
246183242Ssam   -I Str interface      Listen on an interface name or address
247183242Ssam                                - may appear multiple times
248183242Ssam   -k Str keyfile        path to symmetric keys
249183242Ssam   -l Str logfile        path to the log file
250183242Ssam   -L no  novirtualips   Do not listen to virtual interfaces
251156813Sru   -n no  nofork         Do not fork
252136140Sru                                - prohibits the option 'wait-sync'
253124587Sru   -N no  nice           Run at high priority
254124587Sru   -p Str pidfile        path to the PID file
255156813Sru   -P Num priority       Process priority
256148741Sphk   -q no  quit           Set the time and quit
257148741Sphk                                - prohibits these options:
258148741Sphk                                saveconfigquit
259156813Sru                                wait-sync
260124587Sru   -r Str propagationdelay Broadcast/propagation delay
261124587Sru      Str saveconfigquit Save parsed configuration and quit
262135549Sdes                                - prohibits these options:
263135549Sdes                                quit
26453909Speter                                wait-sync
26553909Speter   -s Str statsdir       Statistics file location
266156813Sru   -t Str trustedkey     Trusted key number
267131768Semax                                - may appear multiple times
268131768Semax   -u Str user           Run as userid (or userid:groupid)
269131768Semax   -U Num updateinterval interval in seconds between scans for new or dropped interfaces
270179813Sdougb      Str var            make ARG an ntp variable (RW)
271179813Sdougb                                - may appear multiple times
272179813Sdougb      Str dvar           make ARG an ntp variable (RW|DEF)
273179813Sdougb                                - may appear multiple times
274156813Sru   -w Num wait-sync      Seconds to wait for first clock sync
275148677Sphk                                - prohibits these options:
276148677Sphk                                nofork
277148677Sphk                                quit
278183242Ssam                                saveconfigquit
279183242Ssam   -x no  slew           Slew up to 600 seconds
280183242Ssam      opt version        output version information and exit
281183242Ssam   -? no  help           display extended usage information and exit
282156813Sru   -! no  more-help      extended usage information passed thru pager
283202892Santoine
284124587SruOptions are specified by doubled hyphens and their name or by a single
285202892Santoinehyphen and the flag character.
286124587Sru
287177714Sru
288156256SmuxThe following option preset mechanisms are supported:
289124587Sru - examining environment variables named NTPD_*
290156944Sru
291124587SruPlease send bug reports to:  &lt;http://bugs.ntp.org, bugs@ntp.org&gt;
292183242Ssam</pre>
293183242Ssam  <div class="node">
294148780Sphk<p><hr>
295148780Sphk<a name="ntpd-ipv4"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-ipv6">ntpd ipv6</a>,
296183242SsamPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-usage">ntpd usage</a>,
297183242SsamUp:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
298183242Ssam<br>
299183242Ssam</div>
300183242Ssam
301183242Ssam<h4 class="subsection">ipv4 option (-4)</h4>
302183242Ssam
303183242Ssam<p><a name="index-ntpd_002dipv4-4"></a>
304183242SsamThis is the &ldquo;force ipv4 dns name resolution&rdquo; option.
305183242Ssam
306183242Ssam<p class="noindent">This option has some usage constraints.  It:
307183242Ssam     <ul>
308156813Sru<li>must not appear in combination with any of the following options:
309141789Sdelphijipv6. 
310141785Sdelphij</ul>
311141785Sdelphij
312156813Sru  <p>Force DNS resolution of following host names on the command line
313137675Sbzto the IPv4 namespace. 
314137675Sbz<div class="node">
315137675Sbz<p><hr>
316137675Sbz<a name="ntpd-ipv6"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-authreq">ntpd authreq</a>,
317137675SbzPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-ipv4">ntpd ipv4</a>,
318183242SsamUp:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
319183242Ssam<br>
320183242Ssam</div>
321183242Ssam
322156813Sru<h4 class="subsection">ipv6 option (-6)</h4>
323143026Strhodes
324143026Strhodes<p><a name="index-ntpd_002dipv6-5"></a>
325183242SsamThis is the &ldquo;force ipv6 dns name resolution&rdquo; option.
326183242Ssam
327143026Strhodes<p class="noindent">This option has some usage constraints.  It:
328143026Strhodes     <ul>
329156813Sru<li>must not appear in combination with any of the following options:
330124587Sruipv4. 
33186252Sgshapiro</ul>
33286252Sgshapiro
333183242Ssam  <p>Force DNS resolution of following host names on the command line
334183242Ssamto the IPv6 namespace. 
335183242Ssam<div class="node">
336183242Ssam<p><hr>
337183242Ssam<a name="ntpd-authreq"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-authnoreq">ntpd authnoreq</a>,
338183242SsamPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-ipv6">ntpd ipv6</a>,
339183242SsamUp:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
340183242Ssam<br>
341183242Ssam</div>
342183242Ssam
343156813Sru<h4 class="subsection">authreq option (-a)</h4>
344183333Smarius
345124587Sru<p><a name="index-ntpd_002dauthreq-6"></a>
346124587SruThis is the &ldquo;require crypto authentication&rdquo; option.
347183242Ssam
348183242Ssam<p class="noindent">This option has some usage constraints.  It:
349183242Ssam     <ul>
350124587Sru<li>must not appear in combination with any of the following options:
351183242Ssamauthnoreq. 
352124587Sru</ul>
353183242Ssam
354183242Ssam  <p>Require cryptographic authentication for broadcast client,
355183242Ssammulticast client and symmetric passive associations. 
356124587SruThis is the default. 
357183242Ssam<div class="node">
358183242Ssam<p><hr>
359183242Ssam<a name="ntpd-authnoreq"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-configfile">ntpd configfile</a>,
360124587SruPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-authreq">ntpd authreq</a>,
361124587SruUp:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
362124587Sru<br>
363156813Sru</div>
364124587Sru
365124587Sru<h4 class="subsection">authnoreq option (-A)</h4>
366119553Sphk
367119553Sphk<p><a name="index-ntpd_002dauthnoreq-7"></a>
36834554SjbThis is the &ldquo;do not require crypto authentication&rdquo; option.
369156905Sru
370124587Sru<p class="noindent">This option has some usage constraints.  It:
371124587Sru     <ul>
372156905Sru<li>must not appear in combination with any of the following options:
373124587Sruauthreq. 
37436064Sjb</ul>
37534554Sjb
376161524Smarcel  <p>Do not require cryptographic authentication for broadcast client,
377161524Smarcelmulticast client and symmetric passive associations. 
378161524SmarcelThis is almost never a good idea. 
379161524Smarcel<div class="node">
380117952Speter<p><hr>
381156905Sru<a name="ntpd-configfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-driftfile">ntpd driftfile</a>,
382124587SruPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-authnoreq">ntpd authnoreq</a>,
383124587SruUp:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
384156905Sru<br>
385124587Sru</div>
386117952Speter
387117952Speter<h4 class="subsection">configfile option (-c)</h4>
388150314Simura
389150314Simura<p><a name="index-ntpd_002dconfigfile-8"></a>
390150314SimuraThis is the &ldquo;configuration file name&rdquo; option. 
391150314SimuraThis option takes a string argument. 
392202982SyongariThe name and path of the configuration file,
393202982Syongari<span class="file">/etc/ntp.conf</span>
394202982Syongariby default. 
395202982Syongari<div class="node">
3961590Srgrimes<p><hr>
397<a name="ntpd-driftfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-panicgate">ntpd panicgate</a>,
398Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-configfile">ntpd configfile</a>,
399Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
400<br>
401</div>
402
403<h4 class="subsection">driftfile option (-f)</h4>
404
405<p><a name="index-ntpd_002ddriftfile-9"></a>
406This is the &ldquo;frequency drift file name&rdquo; option. 
407This option takes a string argument. 
408The name and path of the frequency file,
409<span class="file">/etc/ntp.drift</span>
410by default. 
411This is the same operation as the
412<code>driftfile</code> <kbd>driftfile</kbd>
413configuration specification in the
414<span class="file">/etc/ntp.conf</span>
415file. 
416<div class="node">
417<p><hr>
418<a name="ntpd-panicgate"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-force_002dstep_002donce">ntpd force-step-once</a>,
419Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-driftfile">ntpd driftfile</a>,
420Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
421<br>
422</div>
423
424<h4 class="subsection">panicgate option (-g)</h4>
425
426<p><a name="index-ntpd_002dpanicgate-10"></a>
427This is the &ldquo;allow the first adjustment to be big&rdquo; option.
428
429<p class="noindent">This option has some usage constraints.  It:
430     <ul>
431<li>may appear an unlimited number of times. 
432</ul>
433
434  <p>Normally,
435<code>ntpd</code>
436exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that,
437<code>ntpd</code>
438will exit with a message to the system log. This option can be used with the
439<code>-q</code>
440and
441<code>-x</code>
442options. 
443See the
444<code>tinker</code>
445configuration file directive for other options. 
446<div class="node">
447<p><hr>
448<a name="ntpd-force_002dstep_002donce"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-jaildir">ntpd jaildir</a>,
449Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-panicgate">ntpd panicgate</a>,
450Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
451<br>
452</div>
453
454<h4 class="subsection">force-step-once option (-G)</h4>
455
456<p><a name="index-ntpd_002dforce_002dstep_002donce-11"></a>
457This is the &ldquo;step any initial offset correction.&rdquo; option. 
458Normally,
459<code>ntpd</code>
460steps the time if the time offset exceeds the step threshold,
461which is 128 ms by default, and otherwise slews the time. 
462This option forces the initial offset correction to be stepped,
463so the highest time accuracy can be achieved quickly. 
464However, this may also cause the time to be stepped back
465so this option must not be used if
466applications requiring monotonic time are running. 
467See the <code>tinker</code> configuration file directive for other options. 
468<div class="node">
469<p><hr>
470<a name="ntpd-jaildir"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-interface">ntpd interface</a>,
471Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-force_002dstep_002donce">ntpd force-step-once</a>,
472Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
473<br>
474</div>
475
476<h4 class="subsection">jaildir option (-i)</h4>
477
478<p><a name="index-ntpd_002djaildir-12"></a>
479This is the &ldquo;jail directory&rdquo; option. 
480This option takes a string argument.
481
482<p class="noindent">This option has some usage constraints.  It:
483     <ul>
484<li>must be compiled in by defining <code>HAVE_DROPROOT</code> during the compilation. 
485</ul>
486
487  <p>Chroot the server to the directory
488<kbd>jaildir</kbd>
489. 
490This option also implies that the server attempts to drop root privileges at startup. 
491You may need to also specify a
492<code>-u</code>
493option. 
494This option is only available if the OS supports adjusting the clock
495without full root privileges. 
496This option is supported under NetBSD (configure with
497<code>--enable-clockctl</code>) or Linux (configure with
498<code>--enable-linuxcaps</code>) or Solaris (configure with <code>--enable-solarisprivs</code>). 
499<div class="node">
500<p><hr>
501<a name="ntpd-interface"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-keyfile">ntpd keyfile</a>,
502Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-jaildir">ntpd jaildir</a>,
503Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
504<br>
505</div>
506
507<h4 class="subsection">interface option (-I)</h4>
508
509<p><a name="index-ntpd_002dinterface-13"></a>
510This is the &ldquo;listen on an interface name or address&rdquo; option. 
511This option takes a string argument <span class="file">iface</span>.
512
513<p class="noindent">This option has some usage constraints.  It:
514     <ul>
515<li>may appear an unlimited number of times. 
516</ul>
517
518  <p>Open the network address given, or all the addresses associated with the
519given interface name.  This option may appear multiple times.  This option
520also implies not opening other addresses, except wildcard and localhost. 
521This option is deprecated. Please consider using the configuration file
522<code>interface</code> command, which is more versatile. 
523<div class="node">
524<p><hr>
525<a name="ntpd-keyfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-logfile">ntpd logfile</a>,
526Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-interface">ntpd interface</a>,
527Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
528<br>
529</div>
530
531<h4 class="subsection">keyfile option (-k)</h4>
532
533<p><a name="index-ntpd_002dkeyfile-14"></a>
534This is the &ldquo;path to symmetric keys&rdquo; option. 
535This option takes a string argument. 
536Specify the name and path of the symmetric key file. 
537<span class="file">/etc/ntp.keys</span>
538is the default. 
539This is the same operation as the
540<code>keys</code> <kbd>keyfile</kbd>
541configuration file directive. 
542<div class="node">
543<p><hr>
544<a name="ntpd-logfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-novirtualips">ntpd novirtualips</a>,
545Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-keyfile">ntpd keyfile</a>,
546Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
547<br>
548</div>
549
550<h4 class="subsection">logfile option (-l)</h4>
551
552<p><a name="index-ntpd_002dlogfile-15"></a>
553This is the &ldquo;path to the log file&rdquo; option. 
554This option takes a string argument. 
555Specify the name and path of the log file. 
556The default is the system log file. 
557This is the same operation as the
558<code>logfile</code> <kbd>logfile</kbd>
559configuration file directive. 
560<div class="node">
561<p><hr>
562<a name="ntpd-novirtualips"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-modifymmtimer">ntpd modifymmtimer</a>,
563Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-logfile">ntpd logfile</a>,
564Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
565<br>
566</div>
567
568<h4 class="subsection">novirtualips option (-L)</h4>
569
570<p><a name="index-ntpd_002dnovirtualips-16"></a>
571This is the &ldquo;do not listen to virtual interfaces&rdquo; option. 
572Do not listen to virtual interfaces, defined as those with
573names containing a colon.  This option is deprecated.  Please
574consider using the configuration file <code>interface</code> command, which
575is more versatile. 
576<div class="node">
577<p><hr>
578<a name="ntpd-modifymmtimer"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-nice">ntpd nice</a>,
579Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-novirtualips">ntpd novirtualips</a>,
580Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
581<br>
582</div>
583
584<h4 class="subsection">modifymmtimer option (-M)</h4>
585
586<p><a name="index-ntpd_002dmodifymmtimer-17"></a>
587This is the &ldquo;modify multimedia timer (windows only)&rdquo; option.
588
589<p class="noindent">This option has some usage constraints.  It:
590     <ul>
591<li>must be compiled in by defining <code>SYS_WINNT</code> during the compilation. 
592</ul>
593
594  <p>Set the Windows Multimedia Timer to highest resolution.  This
595ensures the resolution does not change while ntpd is running,
596avoiding timekeeping glitches associated with changes. 
597<div class="node">
598<p><hr>
599<a name="ntpd-nice"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-pidfile">ntpd pidfile</a>,
600Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-modifymmtimer">ntpd modifymmtimer</a>,
601Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
602<br>
603</div>
604
605<h4 class="subsection">nice option (-N)</h4>
606
607<p><a name="index-ntpd_002dnice-18"></a>
608This is the &ldquo;run at high priority&rdquo; option. 
609To the extent permitted by the operating system, run
610<code>ntpd</code>
611at the highest priority. 
612<div class="node">
613<p><hr>
614<a name="ntpd-pidfile"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-priority">ntpd priority</a>,
615Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-nice">ntpd nice</a>,
616Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
617<br>
618</div>
619
620<h4 class="subsection">pidfile option (-p)</h4>
621
622<p><a name="index-ntpd_002dpidfile-19"></a>
623This is the &ldquo;path to the pid file&rdquo; option. 
624This option takes a string argument. 
625Specify the name and path of the file used to record
626<code>ntpd</code>'s
627process ID. 
628This is the same operation as the
629<code>pidfile</code> <kbd>pidfile</kbd>
630configuration file directive. 
631<div class="node">
632<p><hr>
633<a name="ntpd-priority"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-quit">ntpd quit</a>,
634Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-pidfile">ntpd pidfile</a>,
635Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
636<br>
637</div>
638
639<h4 class="subsection">priority option (-P)</h4>
640
641<p><a name="index-ntpd_002dpriority-20"></a>
642This is the &ldquo;process priority&rdquo; option. 
643This option takes a number argument. 
644To the extent permitted by the operating system, run
645<code>ntpd</code>
646at the specified
647<code>sched_setscheduler(SCHED_FIFO)</code>
648priority. 
649<div class="node">
650<p><hr>
651<a name="ntpd-quit"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-propagationdelay">ntpd propagationdelay</a>,
652Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-priority">ntpd priority</a>,
653Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
654<br>
655</div>
656
657<h4 class="subsection">quit option (-q)</h4>
658
659<p><a name="index-ntpd_002dquit-21"></a>
660This is the &ldquo;set the time and quit&rdquo; option.
661
662<p class="noindent">This option has some usage constraints.  It:
663     <ul>
664<li>must not appear in combination with any of the following options:
665saveconfigquit, wait-sync. 
666</ul>
667
668  <p><code>ntpd</code>
669will not daemonize and will exit after the clock is first
670synchronized.  This behavior mimics that of the
671<code>ntpdate</code>
672program, which will soon be replaced with a shell script. 
673The
674<code>-g</code>
675and
676<code>-x</code>
677options can be used with this option. 
678Note: The kernel time discipline is disabled with this option. 
679<div class="node">
680<p><hr>
681<a name="ntpd-propagationdelay"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-saveconfigquit">ntpd saveconfigquit</a>,
682Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-quit">ntpd quit</a>,
683Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
684<br>
685</div>
686
687<h4 class="subsection">propagationdelay option (-r)</h4>
688
689<p><a name="index-ntpd_002dpropagationdelay-22"></a>
690This is the &ldquo;broadcast/propagation delay&rdquo; option. 
691This option takes a string argument. 
692Specify the default propagation delay from the broadcast/multicast server to this client. This is necessary only if the delay cannot be computed automatically by the protocol. 
693<div class="node">
694<p><hr>
695<a name="ntpd-saveconfigquit"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-statsdir">ntpd statsdir</a>,
696Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-propagationdelay">ntpd propagationdelay</a>,
697Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
698<br>
699</div>
700
701<h4 class="subsection">saveconfigquit option</h4>
702
703<p><a name="index-ntpd_002dsaveconfigquit-23"></a>
704This is the &ldquo;save parsed configuration and quit&rdquo; option. 
705This option takes a string argument.
706
707<p class="noindent">This option has some usage constraints.  It:
708     <ul>
709<li>must be compiled in by defining <code>SAVECONFIG</code> during the compilation. 
710<li>must not appear in combination with any of the following options:
711quit, wait-sync. 
712</ul>
713
714  <p>Cause <code>ntpd</code> to parse its startup configuration file and save an
715equivalent to the given filename and exit.  This option was
716designed for automated testing. 
717<div class="node">
718<p><hr>
719<a name="ntpd-statsdir"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-trustedkey">ntpd trustedkey</a>,
720Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-saveconfigquit">ntpd saveconfigquit</a>,
721Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
722<br>
723</div>
724
725<h4 class="subsection">statsdir option (-s)</h4>
726
727<p><a name="index-ntpd_002dstatsdir-24"></a>
728This is the &ldquo;statistics file location&rdquo; option. 
729This option takes a string argument. 
730Specify the directory path for files created by the statistics facility. 
731This is the same operation as the
732<code>statsdir</code> <kbd>statsdir</kbd>
733configuration file directive. 
734<div class="node">
735<p><hr>
736<a name="ntpd-trustedkey"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-user">ntpd user</a>,
737Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-statsdir">ntpd statsdir</a>,
738Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
739<br>
740</div>
741
742<h4 class="subsection">trustedkey option (-t)</h4>
743
744<p><a name="index-ntpd_002dtrustedkey-25"></a>
745This is the &ldquo;trusted key number&rdquo; option. 
746This option takes a string argument <span class="file">tkey</span>.
747
748<p class="noindent">This option has some usage constraints.  It:
749     <ul>
750<li>may appear an unlimited number of times. 
751</ul>
752
753  <p>Add the specified key number to the trusted key list. 
754<div class="node">
755<p><hr>
756<a name="ntpd-user"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-updateinterval">ntpd updateinterval</a>,
757Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-trustedkey">ntpd trustedkey</a>,
758Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
759<br>
760</div>
761
762<h4 class="subsection">user option (-u)</h4>
763
764<p><a name="index-ntpd_002duser-26"></a>
765This is the &ldquo;run as userid (or userid:groupid)&rdquo; option. 
766This option takes a string argument.
767
768<p class="noindent">This option has some usage constraints.  It:
769     <ul>
770<li>must be compiled in by defining <code>HAVE_DROPROOT</code> during the compilation. 
771</ul>
772
773  <p>Specify a user, and optionally a group, to switch to. 
774This option is only available if the OS supports adjusting the clock
775without full root privileges. 
776This option is supported under NetBSD (configure with
777<code>--enable-clockctl</code>) or Linux (configure with
778<code>--enable-linuxcaps</code>) or Solaris (configure with <code>--enable-solarisprivs</code>). 
779<div class="node">
780<p><hr>
781<a name="ntpd-updateinterval"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-wait_002dsync">ntpd wait-sync</a>,
782Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-user">ntpd user</a>,
783Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
784<br>
785</div>
786
787<h4 class="subsection">updateinterval option (-U)</h4>
788
789<p><a name="index-ntpd_002dupdateinterval-27"></a>
790This is the &ldquo;interval in seconds between scans for new or dropped interfaces&rdquo; option. 
791This option takes a number argument. 
792Give the time in seconds between two scans for new or dropped interfaces. 
793For systems with routing socket support the scans will be performed shortly after the interface change
794has been detected by the system. 
795Use 0 to disable scanning. 60 seconds is the minimum time between scans. 
796<div class="node">
797<p><hr>
798<a name="ntpd-wait_002dsync"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-slew">ntpd slew</a>,
799Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-updateinterval">ntpd updateinterval</a>,
800Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
801<br>
802</div>
803
804<h4 class="subsection">wait-sync option (-w)</h4>
805
806<p><a name="index-ntpd_002dwait_002dsync-28"></a>
807This is the &ldquo;seconds to wait for first clock sync&rdquo; option. 
808This option takes a number argument.
809
810<p class="noindent">This option has some usage constraints.  It:
811     <ul>
812<li>must be compiled in by defining <code>HAVE_WORKING_FORK</code> during the compilation. 
813<li>must not appear in combination with any of the following options:
814nofork, quit, saveconfigquit. 
815</ul>
816
817  <p>If greater than zero, alters <code>ntpd</code>'s behavior when forking to
818daemonize.  Instead of exiting with status 0 immediately after
819the fork, the parent waits up to the specified number of
820seconds for the child to first synchronize the clock.  The exit
821status is zero (success) if the clock was synchronized,
822otherwise it is <code>ETIMEDOUT</code>. 
823This provides the option for a script starting <code>ntpd</code> to easily
824wait for the first set of the clock before proceeding. 
825<div class="node">
826<p><hr>
827<a name="ntpd-slew"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-usepcc">ntpd usepcc</a>,
828Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-wait_002dsync">ntpd wait-sync</a>,
829Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
830<br>
831</div>
832
833<h4 class="subsection">slew option (-x)</h4>
834
835<p><a name="index-ntpd_002dslew-29"></a>
836This is the &ldquo;slew up to 600 seconds&rdquo; option. 
837Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold. 
838This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually. 
839Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s. 
840Thus, an adjustment as much as 600 s will take almost 14 days to complete. 
841This option can be used with the
842<code>-g</code>
843and
844<code>-q</code>
845options. 
846See the
847<code>tinker</code>
848configuration file directive for other options. 
849Note: The kernel time discipline is disabled with this option. 
850<div class="node">
851<p><hr>
852<a name="ntpd-usepcc"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-pccfreq">ntpd pccfreq</a>,
853Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-slew">ntpd slew</a>,
854Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
855<br>
856</div>
857
858<h4 class="subsection">usepcc option</h4>
859
860<p><a name="index-ntpd_002dusepcc-30"></a>
861This is the &ldquo;use cpu cycle counter (windows only)&rdquo; option.
862
863<p class="noindent">This option has some usage constraints.  It:
864     <ul>
865<li>must be compiled in by defining <code>SYS_WINNT</code> during the compilation. 
866</ul>
867
868  <p>Attempt to substitute the CPU counter for <code>QueryPerformanceCounter</code>. 
869The CPU counter and <code>QueryPerformanceCounter</code> are compared, and if
870they have the same frequency, the CPU counter (RDTSC on x86) is
871used directly, saving the overhead of a system call. 
872<div class="node">
873<p><hr>
874<a name="ntpd-pccfreq"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-mdns">ntpd mdns</a>,
875Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-usepcc">ntpd usepcc</a>,
876Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
877<br>
878</div>
879
880<h4 class="subsection">pccfreq option</h4>
881
882<p><a name="index-ntpd_002dpccfreq-31"></a>
883This is the &ldquo;force cpu cycle counter use (windows only)&rdquo; option. 
884This option takes a string argument.
885
886<p class="noindent">This option has some usage constraints.  It:
887     <ul>
888<li>must be compiled in by defining <code>SYS_WINNT</code> during the compilation. 
889</ul>
890
891  <p>Force substitution the CPU counter for <code>QueryPerformanceCounter</code>. 
892The CPU counter (RDTSC on x86) is used unconditionally with the
893given frequency (in Hz). 
894<div class="node">
895<p><hr>
896<a name="ntpd-mdns"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-config">ntpd config</a>,
897Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-pccfreq">ntpd pccfreq</a>,
898Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
899<br>
900</div>
901
902<h4 class="subsection">mdns option (-m)</h4>
903
904<p><a name="index-ntpd_002dmdns-32"></a>
905This is the &ldquo;register with mdns as a ntp server&rdquo; option.
906
907<p class="noindent">This option has some usage constraints.  It:
908     <ul>
909<li>must be compiled in by defining <code>HAVE_DNSREGISTRATION</code> during the compilation. 
910</ul>
911
912  <p>Registers as an NTP server with the local mDNS server which allows
913the server to be discovered via mDNS client lookup.
914
915<div class="node">
916<p><hr>
917<a name="ntpd-config"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-exit-status">ntpd exit status</a>,
918Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-mdns">ntpd mdns</a>,
919Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
920<br>
921</div>
922
923<h4 class="subsection">presetting/configuring ntpd</h4>
924
925<p>Any option that is not marked as <i>not presettable</i> may be preset by
926loading values from environment variables named <code>NTPD</code> and <code>NTPD_&lt;OPTION_NAME&gt;</code>.  <code>&lt;OPTION_NAME&gt;</code> must be one of
927the options listed above in upper case and segmented with underscores. 
928The <code>NTPD</code> variable will be tokenized and parsed like
929the command line.  The remaining variables are tested for existence and their
930values are treated like option arguments.
931
932  <p>The command line options relating to configuration and/or usage help are:
933
934<h5 class="subsubheading">version (-)</h5>
935
936<p>Print the program version to standard out, optionally with licensing
937information, then exit 0.  The optional argument specifies how much licensing
938detail to provide.  The default is to print just the version.  The licensing infomation may be selected with an option argument. 
939Only the first letter of the argument is examined:
940
941     <dl>
942<dt><span class="samp">version</span><dd>Only print the version.  This is the default. 
943<br><dt><span class="samp">copyright</span><dd>Name the copyright usage licensing terms. 
944<br><dt><span class="samp">verbose</span><dd>Print the full copyright usage licensing terms. 
945</dl>
946
947<div class="node">
948<p><hr>
949<a name="ntpd-exit-status"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-Usage">ntpd Usage</a>,
950Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-config">ntpd config</a>,
951Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
952<br>
953</div>
954
955<h4 class="subsection">ntpd exit status</h4>
956
957<p>One of the following exit values will be returned:
958     <dl>
959<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 
960<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 
961</dl>
962  <div class="node">
963<p><hr>
964<a name="ntpd-Usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-Files">ntpd Files</a>,
965Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-exit-status">ntpd exit status</a>,
966Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
967<br>
968</div>
969
970<h4 class="subsection">ntpd Usage</h4>
971
972<div class="node">
973<p><hr>
974<a name="ntpd-Files"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-See-Also">ntpd See Also</a>,
975Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-Usage">ntpd Usage</a>,
976Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
977<br>
978</div>
979
980<h4 class="subsection">ntpd Files</h4>
981
982<div class="node">
983<p><hr>
984<a name="ntpd-See-Also"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-Bugs">ntpd Bugs</a>,
985Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-Files">ntpd Files</a>,
986Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
987<br>
988</div>
989
990<h4 class="subsection">ntpd See Also</h4>
991
992<div class="node">
993<p><hr>
994<a name="ntpd-Bugs"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpd-Notes">ntpd Notes</a>,
995Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-See-Also">ntpd See Also</a>,
996Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
997<br>
998</div>
999
1000<h4 class="subsection">ntpd Bugs</h4>
1001
1002<div class="node">
1003<p><hr>
1004<a name="ntpd-Notes"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpd-Bugs">ntpd Bugs</a>,
1005Up:&nbsp;<a rel="up" accesskey="u" href="#ntpd-Invocation">ntpd Invocation</a>
1006<br>
1007</div>
1008
1009<h4 class="subsection">ntpd Notes</h4>
1010
1011<div class="node">
1012<p><hr>
1013<a name="Usage"></a>
1014<br>
1015</div>
1016
1017<!-- node-name,  next,  previous,  up -->
1018<h3 class="section">Usage</h3>
1019
1020