ntpdc.html revision 298770 
133965Sjdp<html lang="en">
278828Sobrien<head>
3218822Sdim<title>ntpdc: NTPD Control User's Manual</title>
460484Sobrien<meta http-equiv="Content-Type" content="text/html">
533965Sjdp<meta name="description" content="ntpdc: NTPD Control User's Manual">
633965Sjdp<meta name="generator" content="makeinfo 4.7">
7130561Sobrien<link title="Top" rel="top" href="#Top">
833965Sjdp<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9130561Sobrien<meta http-equiv="Content-Style-Type" content="text/css">
10130561Sobrien<style type="text/css"><!--
11130561Sobrien  pre.display { font-family:inherit }
12130561Sobrien  pre.format  { font-family:inherit }
1333965Sjdp  pre.smalldisplay { font-family:inherit; font-size:smaller }
14130561Sobrien  pre.smallformat  { font-family:inherit; font-size:smaller }
15130561Sobrien  pre.smallexample { font-size:smaller }
16130561Sobrien  pre.smalllisp    { font-size:smaller }
17130561Sobrien  span.sc { font-variant:small-caps }
1833965Sjdp  span.roman { font-family: serif; font-weight: normal; } 
19130561Sobrien--></style>
20130561Sobrien</head>
21208737Sjmallett<body>
2233965Sjdp<h1 class="settitle">ntpdc: NTPD Control User's Manual</h1>
23218822Sdim<div class="node">
2433965Sjdp<p><hr>
2533965Sjdp<a name="Top"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-Description">ntpdc Description</a>,
2689857SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
2733965SjdpUp:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
2833965Sjdp<br>
2933965Sjdp</div>
3033965Sjdp
3133965Sjdp<h2 class="unnumbered">ntpdc: NTPD Control User Manual</h2>
3233965Sjdp
3333965Sjdp<p>This document describes the use of the NTP Project's <code>ntpdc</code> program,
3433965Sjdpthat can be used to query a Network Time Protocol (NTP) server and
3577298Sobriendisplay the time offset of the system clock relative to the server
3633965Sjdpclock.  Run as root, it can correct the system clock to this offset as
3733965Sjdpwell.  It can be run as an interactive command or from a cron job.
3833965Sjdp
3933965Sjdp  <p>This document applies to version 4.2.8p7 of <code>ntpdc</code>.
4033965Sjdp
4133965Sjdp  <p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
4233965SjdpIETF specification.
4333965Sjdp
4433965Sjdp  <div class="shortcontents">
4577298Sobrien<h2>Short Contents</h2>
4633965Sjdp<ul>
4733965Sjdp<a href="#Top">ntpdc: NTPD Control User Manual</a>
4833965Sjdp</ul>
4933965Sjdp</div>
5033965Sjdp
5177298Sobrien<ul class="menu">
5233965Sjdp<li><a accesskey="1" href="#ntpdc-Description">ntpdc Description</a>:             Description
5333965Sjdp<li><a accesskey="2" href="#ntpdc-Invocation">ntpdc Invocation</a>: 		Invoking ntpdc
5433965Sjdp<li><a accesskey="3" href="#Usage">Usage</a>:                        Usage
5533965Sjdp</ul>
5633965Sjdp
5733965Sjdp<div class="node">
5833965Sjdp<p><hr>
5933965Sjdp<a name="ntpdc-Description"></a>
6033965Sjdp<br>
6133965Sjdp</div>
6233965Sjdp
6333965Sjdp<!-- node-name,  next,  previous,  up -->
6433965Sjdp<h3 class="section">Description</h3>
6533965Sjdp
6633965Sjdp<p>By default, <code>ntpdc</code> writes the local data and time (i.e., not UTC) to the
6733965Sjdpstandard output in the format:
6877298Sobrien
6933965Sjdp<pre class="example">     1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
7077298Sobrien</pre>
7133965Sjdp  <p>where
7291041SobrienYYYY-MM-DD HH:MM:SS.SUBSEC is the local date and time,
7391041Sobrien(+0800) is the local timezone adjustment (so we would add 8 hours and 0 minutes to convert the reported local time to UTC),
7433965Sjdpand
7538889Sjdpthe +4.567 +/- 0.089 secs indicates the time offset and
7638889Sjdperror bound of the system clock relative to the server clock.
7738889Sjdp
7838889Sjdp<div class="node">
7938889Sjdp<p><hr>
8038889Sjdp<a name="ntpdc-Invocation"></a>
8138889Sjdp<br>
8260484Sobrien</div>
83218822Sdim
84218822Sdim<h3 class="section">Invoking ntpdc</h3>
85218822Sdim
86218822Sdim<p><a name="index-ntpdc-1"></a><a name="index-vendor_002dspecific-NTPD-control-program-2"></a>
87218822Sdim
88218822Sdim  <p><code>ntpdc</code>
89218822Sdimis deprecated. 
90218822SdimPlease use
91218822Sdim<code>ntpq(1ntpqmdoc)</code> instead - it can do everything
92218822Sdim<code>ntpdc</code>
93218822Sdimused to do, and it does so using a much more sane interface.
94218822Sdim
95218822Sdim  <p><code>ntpdc</code>
96218822Sdimis a utility program used to query
97218822Sdim<code>ntpd(1ntpdmdoc)</code>
98218822Sdimabout its
99218822Sdimcurrent state and to request changes in that state. 
100218822SdimIt uses NTP mode 7 control message formats described in the source code. 
101218822SdimThe program may
102218822Sdimbe run either in interactive mode or controlled using command line
10377298Sobrienarguments. 
10433965SjdpExtensive state and statistics information is available
10533965Sjdpthrough the
10677298Sobrien<code>ntpdc</code>
10733965Sjdpinterface. 
10833965SjdpIn addition, nearly all the
10933965Sjdpconfiguration options which can be specified at startup using
11077298Sobrienntpd's configuration file may also be specified at run time using
11191041Sobrien<code>ntpdc</code>
11233965Sjdp
11333965Sjdp  <p>This section was generated by <strong>AutoGen</strong>,
11433965Sjdpusing the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpdc</code> program. 
11533965SjdpThis software is released under the NTP license, &lt;http://ntp.org/license>;.
11633965Sjdp
11733965Sjdp<ul class="menu">
11833965Sjdp<li><a accesskey="1" href="#ntpdc-usage">ntpdc usage</a>:                   ntpdc help/usage (<span class="option">--help</span>)
11933965Sjdp<li><a accesskey="2" href="#ntpdc-ipv4">ntpdc ipv4</a>:                    ipv4 option (-4)
12033965Sjdp<li><a accesskey="3" href="#ntpdc-ipv6">ntpdc ipv6</a>:                    ipv6 option (-6)
12133965Sjdp<li><a accesskey="4" href="#ntpdc-command">ntpdc command</a>:                 command option (-c)
12291041Sobrien<li><a accesskey="5" href="#ntpdc-interactive">ntpdc interactive</a>:             interactive option (-i)
12391041Sobrien<li><a accesskey="6" href="#ntpdc-listpeers">ntpdc listpeers</a>:               listpeers option (-l)
12433965Sjdp<li><a accesskey="7" href="#ntpdc-numeric">ntpdc numeric</a>:                 numeric option (-n)
12533965Sjdp<li><a accesskey="8" href="#ntpdc-peers">ntpdc peers</a>:                   peers option (-p)
12633965Sjdp<li><a accesskey="9" href="#ntpdc-showpeers">ntpdc showpeers</a>:               showpeers option (-s)
12733965Sjdp<li><a href="#ntpdc-config">ntpdc config</a>:                  presetting/configuring ntpdc
12833965Sjdp<li><a href="#ntpdc-exit-status">ntpdc exit status</a>:             exit status
12933965Sjdp<li><a href="#ntpdc-Usage">ntpdc Usage</a>:                   Usage
13091041Sobrien<li><a href="#ntpdc-See-Also">ntpdc See Also</a>:                See Also
13160484Sobrien<li><a href="#ntpdc-Authors">ntpdc Authors</a>:                 Authors
13260484Sobrien<li><a href="#ntpdc-Bugs">ntpdc Bugs</a>:                    Bugs
13391041Sobrien</ul>
13491041Sobrien
13591041Sobrien<div class="node">
13633965Sjdp<p><hr>
13733965Sjdp<a name="ntpdc-usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-ipv4">ntpdc ipv4</a>,
13877298SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
13977298Sobrien<br>
140218822Sdim</div>
141218822Sdim
142218822Sdim<h4 class="subsection">ntpdc help/usage (<span class="option">--help</span>)</h4>
143218822Sdim
144218822Sdim<p><a name="index-ntpdc-help-3"></a>
14533965SjdpThis is the automatically generated usage text for ntpdc.
14638889Sjdp
14738889Sjdp  <p>The text printed is the same whether selected with the <code>help</code> option
14838889Sjdp(<span class="option">--help</span>) or the <code>more-help</code> option (<span class="option">--more-help</span>).  <code>more-help</code> will print
14938889Sjdpthe usage text by passing it through a pager program. 
15038889Sjdp<code>more-help</code> is disabled on platforms without a working
15160484Sobrien<code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
152130561Sobrienused to select the program, defaulting to <span class="file">more</span>.  Both will exit
15338889Sjdpwith a status code of 0.
15438889Sjdp
15538889Sjdp<pre class="example">ntpdc - vendor-specific NTPD control program - Ver. 4.2.8p7
15638889SjdpUsage:  ntpdc [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]... [ host ...]
15738889Sjdp  Flg Arg Option-Name    Description
158130561Sobrien   -4 no  ipv4           Force IPv4 DNS name resolution
159130561Sobrien                                - prohibits the option 'ipv6'
16038889Sjdp   -6 no  ipv6           Force IPv6 DNS name resolution
161130561Sobrien                                - prohibits the option 'ipv4'
16238889Sjdp   -c Str command        run a command and exit
163208737Sjmallett                                - may appear multiple times
16438889Sjdp   -d no  debug-level    Increase debug verbosity level
16578828Sobrien                                - may appear multiple times
16638889Sjdp   -D Num set-debug-level Set the debug verbosity level
16777298Sobrien                                - may appear multiple times
168208737Sjmallett   -i no  interactive    Force ntpq to operate in interactive mode
16977298Sobrien                                - prohibits these options:
17089857Sobrien                                command
171130561Sobrien                                listpeers
17289857Sobrien                                peers
173130561Sobrien                                showpeers
17433965Sjdp   -l no  listpeers      Print a list of the peers
175130561Sobrien                                - prohibits the option 'command'
176130561Sobrien   -n no  numeric        numeric host addresses
177130561Sobrien   -p no  peers          Print a list of the peers
178130561Sobrien                                - prohibits the option 'command'
179130561Sobrien   -s no  showpeers      Show a list of the peers
18033965Sjdp                                - prohibits the option 'command'
18133965Sjdp      opt version        output version information and exit
18233965Sjdp   -? no  help           display extended usage information and exit
18360484Sobrien   -! no  more-help      extended usage information passed thru pager
18433965Sjdp   -&gt; opt save-opts      save the option state to a config file
18533965Sjdp   -&lt; Str load-opts      load options from a config file
18633965Sjdp                                - disabled as '--no-load-opts'
187130561Sobrien                                - may appear multiple times
18833965Sjdp
189130561SobrienOptions are specified by doubled hyphens and their name or by a single
190130561Sobrienhyphen and the flag character.
191130561Sobrien
192130561Sobrien
193130561SobrienThe following option preset mechanisms are supported:
194130561Sobrien - reading file $HOME/.ntprc
195130561Sobrien - reading file ./.ntprc
196130561Sobrien - examining environment variables named NTPDC_*
19789857Sobrien
19833965SjdpPlease send bug reports to:  &lt;http://bugs.ntp.org, bugs@ntp.org&gt;
199130561Sobrien</pre>
200130561Sobrien  <div class="node">
20177298Sobrien<p><hr>
20277298Sobrien<a name="ntpdc-ipv4"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-ipv6">ntpdc ipv6</a>,
20377298SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-usage">ntpdc usage</a>,
20477298SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
20577298Sobrien<br>
20677298Sobrien</div>
20777298Sobrien
20877298Sobrien<h4 class="subsection">ipv4 option (-4)</h4>
20977298Sobrien
21077298Sobrien<p><a name="index-ntpdc_002dipv4-4"></a>
21177298SobrienThis is the &ldquo;force ipv4 dns name resolution&rdquo; option.
21277298Sobrien
21377298Sobrien<p class="noindent">This option has some usage constraints.  It:
21477298Sobrien     <ul>
21577298Sobrien<li>must not appear in combination with any of the following options:
21677298Sobrienipv6. 
217130561Sobrien</ul>
21833965Sjdp
219130561Sobrien  <p>Force DNS resolution of following host names on the command line
22077298Sobriento the IPv4 namespace. 
22177298Sobrien<div class="node">
22277298Sobrien<p><hr>
22333965Sjdp<a name="ntpdc-ipv6"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-command">ntpdc command</a>,
224130561SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-ipv4">ntpdc ipv4</a>,
225130561SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
226130561Sobrien<br>
227130561Sobrien</div>
22833965Sjdp
229130561Sobrien<h4 class="subsection">ipv6 option (-6)</h4>
23060484Sobrien
23160484Sobrien<p><a name="index-ntpdc_002dipv6-5"></a>
23260484SobrienThis is the &ldquo;force ipv6 dns name resolution&rdquo; option.
233104834Sobrien
23477298Sobrien<p class="noindent">This option has some usage constraints.  It:
23577298Sobrien     <ul>
236130561Sobrien<li>must not appear in combination with any of the following options:
237130561Sobrienipv4. 
238130561Sobrien</ul>
23933965Sjdp
24033965Sjdp  <p>Force DNS resolution of following host names on the command line
24133965Sjdpto the IPv6 namespace. 
242130561Sobrien<div class="node">
243130561Sobrien<p><hr>
244130561Sobrien<a name="ntpdc-command"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-interactive">ntpdc interactive</a>,
24560484SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-ipv6">ntpdc ipv6</a>,
24660484SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
247218822Sdim<br>
248218822Sdim</div>
249218822Sdim
250218822Sdim<h4 class="subsection">command option (-c)</h4>
251218822Sdim
252218822Sdim<p><a name="index-ntpdc_002dcommand-6"></a>
253130561SobrienThis is the &ldquo;run a command and exit&rdquo; option. 
25438889SjdpThis option takes a string argument <span class="file">cmd</span>.
255218822Sdim
25660484Sobrien<p class="noindent">This option has some usage constraints.  It:
25738889Sjdp     <ul>
25838889Sjdp<li>may appear an unlimited number of times. 
259130561Sobrien</ul>
260218822Sdim
261130561Sobrien  <p>The following argument is interpreted as an interactive format command
262130561Sobrienand is added to the list of commands to be executed on the specified
263130561Sobrienhost(s). 
26491041Sobrien<div class="node">
26533965Sjdp<p><hr>
26660484Sobrien<a name="ntpdc-interactive"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-listpeers">ntpdc listpeers</a>,
26760484SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-command">ntpdc command</a>,
26860484SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
26991041Sobrien<br>
270130561Sobrien</div>
27138889Sjdp
27260484Sobrien<h4 class="subsection">interactive option (-i)</h4>
27338889Sjdp
27438889Sjdp<p><a name="index-ntpdc_002dinteractive-7"></a>
27560484SobrienThis is the &ldquo;force ntpq to operate in interactive mode&rdquo; option.
27638889Sjdp
27760484Sobrien<p class="noindent">This option has some usage constraints.  It:
27860484Sobrien     <ul>
27977298Sobrien<li>must not appear in combination with any of the following options:
28077298Sobriencommand, listpeers, peers, showpeers. 
281130561Sobrien</ul>
282130561Sobrien
283218822Sdim  <p>Force ntpq to operate in interactive mode.  Prompts will be written
28433965Sjdpto the standard output and commands read from the standard input. 
28533965Sjdp<div class="node">
28638889Sjdp<p><hr>
287130561Sobrien<a name="ntpdc-listpeers"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-numeric">ntpdc numeric</a>,
288130561SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-interactive">ntpdc interactive</a>,
289130561SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
29077298Sobrien<br>
29160484Sobrien</div>
29238889Sjdp
293130561Sobrien<h4 class="subsection">listpeers option (-l)</h4>
29460484Sobrien
295130561Sobrien<p><a name="index-ntpdc_002dlistpeers-8"></a>
29677298SobrienThis is the &ldquo;print a list of the peers&rdquo; option.
297130561Sobrien
298130561Sobrien<p class="noindent">This option has some usage constraints.  It:
299130561Sobrien     <ul>
300130561Sobrien<li>must not appear in combination with any of the following options:
301218822Sdimcommand. 
302218822Sdim</ul>
303218822Sdim
304130561Sobrien  <p>Print a list of the peers known to the server as well as a summary of
305130561Sobrientheir state. This is equivalent to the 'listpeers' interactive command. 
30660484Sobrien<div class="node">
307130561Sobrien<p><hr>
30833965Sjdp<a name="ntpdc-numeric"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-peers">ntpdc peers</a>,
30933965SjdpPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-listpeers">ntpdc listpeers</a>,
31060484SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
31160484Sobrien<br>
312130561Sobrien</div>
31360484Sobrien
31460484Sobrien<h4 class="subsection">numeric option (-n)</h4>
315104834Sobrien
316130561Sobrien<p><a name="index-ntpdc_002dnumeric-9"></a>
317130561SobrienThis is the &ldquo;numeric host addresses&rdquo; option. 
318104834SobrienOutput all host addresses in dotted-quad numeric format rather than
319104834Sobrienconverting to the canonical host names. 
320218822Sdim<div class="node">
321104834Sobrien<p><hr>
322104834Sobrien<a name="ntpdc-peers"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-showpeers">ntpdc showpeers</a>,
323130561SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-numeric">ntpdc numeric</a>,
32460484SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
325218822Sdim<br>
326218822Sdim</div>
327218822Sdim
32877298Sobrien<h4 class="subsection">peers option (-p)</h4>
329130561Sobrien
330130561Sobrien<p><a name="index-ntpdc_002dpeers-10"></a>
331130561SobrienThis is the &ldquo;print a list of the peers&rdquo; option.
332130561Sobrien
333130561Sobrien<p class="noindent">This option has some usage constraints.  It:
334130561Sobrien     <ul>
335130561Sobrien<li>must not appear in combination with any of the following options:
336130561Sobriencommand. 
337218822Sdim</ul>
338218822Sdim
339218822Sdim  <p>Print a list of the peers known to the server as well as a summary
340218822Sdimof their state. This is equivalent to the 'peers' interactive command. 
34160484Sobrien<div class="node">
34291041Sobrien<p><hr>
34360484Sobrien<a name="ntpdc-showpeers"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-config">ntpdc config</a>,
34460484SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-peers">ntpdc peers</a>,
34560484SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
34660484Sobrien<br>
34777298Sobrien</div>
348218822Sdim
349218822Sdim<h4 class="subsection">showpeers option (-s)</h4>
350218822Sdim
351218822Sdim<p><a name="index-ntpdc_002dshowpeers-11"></a>
352218822SdimThis is the &ldquo;show a list of the peers&rdquo; option.
353218822Sdim
354218822Sdim<p class="noindent">This option has some usage constraints.  It:
355218822Sdim     <ul>
356218822Sdim<li>must not appear in combination with any of the following options:
35777298Sobriencommand. 
358218822Sdim</ul>
359218822Sdim
360218822Sdim  <p>Print a list of the peers known to the server as well as a summary
36189857Sobrienof their state. This is equivalent to the 'dmpeers' interactive command.
362130561Sobrien
363130561Sobrien<div class="node">
364218822Sdim<p><hr>
36589857Sobrien<a name="ntpdc-config"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-exit-status">ntpdc exit status</a>,
36691041SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-showpeers">ntpdc showpeers</a>,
36789857SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
368130561Sobrien<br>
369130561Sobrien</div>
370130561Sobrien
371130561Sobrien<h4 class="subsection">presetting/configuring ntpdc</h4>
372130561Sobrien
373130561Sobrien<p>Any option that is not marked as <i>not presettable</i> may be preset by
374130561Sobrienloading values from configuration ("rc" or "ini") files, and values from environment variables named <code>NTPDC</code> and <code>NTPDC_&lt;OPTION_NAME&gt;</code>.  <code>&lt;OPTION_NAME&gt;</code> must be one of
375130561Sobrienthe options listed above in upper case and segmented with underscores. 
376218822SdimThe <code>NTPDC</code> variable will be tokenized and parsed like
377218822Sdimthe command line.  The remaining variables are tested for existence and their
378130561Sobrienvalues are treated like option arguments.
379130561Sobrien
380130561Sobrien<p class="noindent"><code>libopts</code> will search in 2 places for configuration files:
381130561Sobrien     <ul>
382130561Sobrien<li>$HOME
383130561Sobrien<li>$PWD
384130561Sobrien</ul>
385218822Sdim  The environment variables <code>HOME</code>, and <code>PWD</code>
386218822Sdimare expanded and replaced when <span class="file">ntpdc</span> runs. 
387218822SdimFor any of these that are plain files, they are simply processed. 
388218822SdimFor any that are directories, then a file named <span class="file">.ntprc</span> is searched for
389130561Sobrienwithin that directory and processed.
390130561Sobrien
391218822Sdim  <p>Configuration files may be in a wide variety of formats. 
392218822SdimThe basic format is an option name followed by a value (argument) on the
393218822Sdimsame line.  Values may be separated from the option name with a colon,
394218822Sdimequal sign or simply white space.  Values may be continued across multiple
395218822Sdimlines by escaping the newline with a backslash.
396218822Sdim
397218822Sdim  <p>Multiple programs may also share the same initialization file. 
398218822SdimCommon options are collected at the top, followed by program specific
39933965Sjdpsegments.  The segments are separated by lines like:
40033965Sjdp<pre class="example">    [NTPDC]
40133965Sjdp</pre>
40233965Sjdp  <p class="noindent">or by
40333965Sjdp<pre class="example">    &lt;?program ntpdc&gt;
40433965Sjdp</pre>
40533965Sjdp  <p class="noindent">Do not mix these styles within one configuration file.
40633965Sjdp
40733965Sjdp  <p>Compound values and carefully constructed string values may also be
40833965Sjdpspecified using XML syntax:
40933965Sjdp<pre class="example">    &lt;option-name&gt;
41033965Sjdp       &lt;sub-opt&gt;...&amp;lt;...&amp;gt;...&lt;/sub-opt&gt;
41133965Sjdp    &lt;/option-name&gt;
41277298Sobrien</pre>
41333965Sjdp  <p class="noindent">yielding an <code>option-name.sub-opt</code> string value of
41433965Sjdp<pre class="example">    "...&lt;...&gt;..."
41533965Sjdp</pre>
41633965Sjdp  <p><code>AutoOpts</code> does not track suboptions.  You simply note that it is a
41733965Sjdphierarchicly valued option.  <code>AutoOpts</code> does provide a means for searching
41833965Sjdpthe associated name/value pair list (see: optionFindValue).
41933965Sjdp
42033965Sjdp  <p>The command line options relating to configuration and/or usage help are:
42133965Sjdp
422130561Sobrien<h5 class="subsubheading">version (-)</h5>
42399461Sobrien
42499461Sobrien<p>Print the program version to standard out, optionally with licensing
425130561Sobrieninformation, then exit 0.  The optional argument specifies how much licensing
42633965Sjdpdetail to provide.  The default is to print just the version.  The licensing infomation may be selected with an option argument. 
427130561SobrienOnly the first letter of the argument is examined:
42833965Sjdp
429130561Sobrien     <dl>
43033965Sjdp<dt><span class="samp">version</span><dd>Only print the version.  This is the default. 
43133965Sjdp<br><dt><span class="samp">copyright</span><dd>Name the copyright usage licensing terms. 
43291041Sobrien<br><dt><span class="samp">verbose</span><dd>Print the full copyright usage licensing terms. 
43391041Sobrien</dl>
43491041Sobrien
43533965Sjdp<div class="node">
43633965Sjdp<p><hr>
43733965Sjdp<a name="ntpdc-exit-status"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-Usage">ntpdc Usage</a>,
43838889SjdpPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-config">ntpdc config</a>,
43933965SjdpUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
44091041Sobrien<br>
441218822Sdim</div>
442218822Sdim
443218822Sdim<h4 class="subsection">ntpdc exit status</h4>
44477298Sobrien
445218822Sdim<p>One of the following exit values will be returned:
44633965Sjdp     <dl>
44760484Sobrien<dt><span class="samp">0 (EXIT_SUCCESS)</span><dd>Successful program execution. 
448104834Sobrien<br><dt><span class="samp">1 (EXIT_FAILURE)</span><dd>The operation failed or the command syntax was not valid. 
44991041Sobrien<br><dt><span class="samp">66 (EX_NOINPUT)</span><dd>A specified configuration file could not be loaded. 
450104834Sobrien<br><dt><span class="samp">70 (EX_SOFTWARE)</span><dd>libopts had an internal operational error.  Please report
45133965Sjdpit to autogen-users@lists.sourceforge.net.  Thank you. 
45233965Sjdp</dl>
45333965Sjdp  <div class="node">
45460484Sobrien<p><hr>
45533965Sjdp<a name="ntpdc-Usage"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-See-Also">ntpdc See Also</a>,
45633965SjdpPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-exit-status">ntpdc exit status</a>,
45733965SjdpUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
45891041Sobrien<br>
459130561Sobrien</div>
460130561Sobrien
461218822Sdim<h4 class="subsection">ntpdc Usage</h4>
46233965Sjdp
46377298Sobrien<div class="node">
46477298Sobrien<p><hr>
46533965Sjdp<a name="ntpdc-See-Also"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-Authors">ntpdc Authors</a>,
46633965SjdpPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-Usage">ntpdc Usage</a>,
467218822SdimUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
46891041Sobrien<br>
469218822Sdim</div>
47033965Sjdp
47191041Sobrien<h4 class="subsection">ntpdc See Also</h4>
47233965Sjdp
47333965Sjdp<div class="node">
474130561Sobrien<p><hr>
475218822Sdim<a name="ntpdc-Authors"></a>Next:&nbsp;<a rel="next" accesskey="n" href="#ntpdc-Bugs">ntpdc Bugs</a>,
47691041SobrienPrevious:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-See-Also">ntpdc See Also</a>,
47791041SobrienUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
47891041Sobrien<br>
47989857Sobrien</div>
48091041Sobrien
48191041Sobrien<h4 class="subsection">ntpdc Authors</h4>
48291041Sobrien
48333965Sjdp<div class="node">
48491041Sobrien<p><hr>
485218822Sdim<a name="ntpdc-Bugs"></a>Previous:&nbsp;<a rel="previous" accesskey="p" href="#ntpdc-Authors">ntpdc Authors</a>,
48633965SjdpUp:&nbsp;<a rel="up" accesskey="u" href="#ntpdc-Invocation">ntpdc Invocation</a>
48733965Sjdp<br>
488218822Sdim</div>
48938889Sjdp
490130561Sobrien<h4 class="subsection">ntpdc Bugs</h4>
49177298Sobrien
49260484Sobrien<div class="node">
49391041Sobrien<p><hr>
49433965Sjdp<a name="Usage"></a>
49533965Sjdp<br>
49633965Sjdp</div>
49789857Sobrien
498130561Sobrien<!-- node-name,  next,  previous,  up -->
499218822Sdim<h3 class="section">Usage</h3>
500218822Sdim
50191041Sobrien<p>The simplest use of this program is as an unprivileged command to
50233965Sjdpcheck the current time, offset, and error in the local clock. 
50391041SobrienFor example:
50491041Sobrien
50533965Sjdp<pre class="example">    ntpdc ntpserver.somewhere
50691041Sobrien</pre>
50733965Sjdp  <p>With suitable privilege, it can be run as a command or in a
50891041Sobrien<code>cron</code> job to reset the local clock from a reliable server, like
50991041Sobrienthe <code>ntpdate</code> and <code>rdate</code> commands. 
51091041SobrienFor example:
51191041Sobrien
512218822Sdim<pre class="example">    ntpdc -a ntpserver.somewhere
513218822Sdim</pre>
514218822Sdim  </body></html>
51591041Sobrien
516218822Sdim