contrib/ntp/ntpdc/ntpdc.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6 <title>ntpdc: NTPD Control User&rsquo;s Manual</title>
   7
   8 <meta name="description" content="ntpdc: NTPD Control User&rsquo;s Manual">
   9 <meta name="keywords" content="ntpdc: NTPD Control User&rsquo;s Manual">
  10 <meta name="resource-type" content="document">
  11 <meta name="distribution" content="global">
  12 <meta name="Generator" content="makeinfo">
  13 <link href="#Top" rel="start" title="Top">
  14 <link href="dir.html#Top" rel="up" title="(dir)">
  15 <style type="text/css">
  16 <!--
  17 a.summary-letter {text-decoration: none}
  18 blockquote.indentedblock {margin-right: 0em}
  19 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  20 blockquote.smallquotation {font-size: smaller}
  21 div.display {margin-left: 3.2em}
  22 div.example {margin-left: 3.2em}
  23 div.lisp {margin-left: 3.2em}
  24 div.smalldisplay {margin-left: 3.2em}
  25 div.smallexample {margin-left: 3.2em}
  26 div.smalllisp {margin-left: 3.2em}
  27 kbd {font-style: oblique}
  28 pre.display {font-family: inherit}
  29 pre.format {font-family: inherit}
  30 pre.menu-comment {font-family: serif}
  31 pre.menu-preformatted {font-family: serif}
  32 pre.smalldisplay {font-family: inherit; font-size: smaller}
  33 pre.smallexample {font-size: smaller}
  34 pre.smallformat {font-family: inherit; font-size: smaller}
  35 pre.smalllisp {font-size: smaller}
  36 span.nolinebreak {white-space: nowrap}
  37 span.roman {font-family: initial; font-weight: normal}
  38 span.sansserif {font-family: sans-serif; font-weight: normal}
  39 ul.no-bullet {list-style: none}
  40 -->
  41 </style>
  42
  43
  44 </head>
  45
  46 <body lang="en">
  47 <h1 class="settitle" align="center">ntpdc: NTPD Control User&rsquo;s Manual</h1>
  48
  49
  50
  51
  52
  53 <a name="Top"></a>
  54 <div class="header">
  55 <p>
  56 Next: <a href="#ntpdc-Description" accesskey="n" rel="next">ntpdc Description</a>, Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> &nbsp; </p>
  57 </div>
  58 <a name="ntpdc_003a-NTPD-Control-User-Manual"></a>
  59 <h1 class="top">ntpdc: NTPD Control User Manual</h1>
  60
  61 <p>This document describes the use of the NTP Project&rsquo;s <code>ntpdc</code> program,
  62 that can be used to query a Network Time Protocol (NTP) server and
  63 display the time offset of the system clock relative to the server
  64 clock.  Run as root, it can correct the system clock to this offset as
  65 well.  It can be run as an interactive command or from a cron job.
  66 </p>
  67 <p>This document applies to version 4.2.8p14 of <code>ntpdc</code>.
  68 </p>
  69 <p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
  70 IETF specification.
  71 </p>
  72 <a name="SEC_Overview"></a>
  73 <h2 class="shortcontents-heading">Short Table of Contents</h2>
  74
  75 <div class="shortcontents">
  76 <ul class="no-bullet">
  77 <li><a name="stoc-Description" href="#toc-Description">1 Description</a></li>
  78 </ul>
  79 </div>
  80
  81
  82 <table class="menu" border="0" cellspacing="0">
  83 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-Description" accesskey="1">ntpdc Description</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Description
  84 </td></tr>
  85 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-Invocation" accesskey="2">ntpdc Invocation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Invoking ntpdc
  86 </td></tr>
  87 <tr><td align="left" valign="top">&bull; <a href="#Usage" accesskey="3">Usage</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Usage
  88 </td></tr>
  89 </table>
  90
  91 <hr>
  92 <a name="ntpdc-Description"></a>
  93 <div class="header">
  94 <p>
  95 Next: <a href="#ntpdc-Invocation" accesskey="n" rel="next">ntpdc Invocation</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; </p>
  96 </div>
  97 <a name="Description"></a>
  98 <h2 class="chapter">1 Description</h2>
  99
 100 <p>By default, <code>ntpdc</code> writes the local data and time (i.e., not UTC) to the
 101 standard output in the format:
 102 </p>
 103 <div class="example">
 104 <pre class="example">1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
 105 </pre></div>
 106
 107 <p>where
 108 YYYY-MM-DD HH:MM:SS.SUBSEC is the local date and time,
 109 (+0800) is the local timezone adjustment (so we would add 8 hours and 0 minutes to convert the reported local time to UTC),
 110 and
 111 the +4.567 +/- 0.089 secs indicates the time offset and
 112 error bound of the system clock relative to the server clock.
 113 </p>
 114 <table class="menu" border="0" cellspacing="0">
 115 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-Invocation" accesskey="1">ntpdc Invocation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 116 </td></tr>
 117 <tr><td align="left" valign="top">&bull; <a href="#Usage" accesskey="2">Usage</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 118 </td></tr>
 119 </table>
 120
 121 <hr>
 122 <a name="ntpdc-Invocation"></a>
 123 <div class="header">
 124 <p>
 125 Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#ntpdc-Description" accesskey="p" rel="prev">ntpdc Description</a>, Up: <a href="#ntpdc-Description" accesskey="u" rel="up">ntpdc Description</a> &nbsp; </p>
 126 </div>
 127 <a name="Invoking-ntpdc"></a>
 128 <h3 class="section">1.1 Invoking ntpdc</h3>
 129 <a name="index-ntpdc"></a>
 130 <a name="index-vendor_002dspecific-NTPD-control-program"></a>
 131
 132
 133
 134 <p><code>ntpdc</code>
 135 is deprecated.
 136 Please use
 137 <code>ntpq(1ntpqmdoc)</code> instead - it can do everything
 138 <code>ntpdc</code>
 139 used to do, and it does so using a much more sane interface.
 140 </p>
 141 <p><code>ntpdc</code>
 142 is a utility program used to query
 143 <code>ntpd(1ntpdmdoc)</code>
 144 about its
 145 current state and to request changes in that state.
 146 It uses NTP mode 7 control message formats described in the source code.
 147 The program may
 148 be run either in interactive mode or controlled using command line
 149 arguments.
 150 Extensive state and statistics information is available
 151 through the
 152 <code>ntpdc</code>
 153 interface.
 154 In addition, nearly all the
 155 configuration options which can be specified at startup using
 156 ntpd&rsquo;s configuration file may also be specified at run time using
 157 <code>ntpdc</code>
 158 </p>
 159 <p>This section was generated by <strong>AutoGen</strong>,
 160 using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpdc</code> program.
 161 This software is released under the NTP license, &lt;http://ntp.org/license&gt;.
 162 </p>
 163 <table class="menu" border="0" cellspacing="0">
 164 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-usage" accesskey="1">ntpdc usage</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">ntpdc help/usage (<samp>--help</samp>)
 165 </td></tr>
 166 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-ipv4" accesskey="2">ntpdc ipv4</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">ipv4 option (-4)
 167 </td></tr>
 168 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-ipv6" accesskey="3">ntpdc ipv6</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">ipv6 option (-6)
 169 </td></tr>
 170 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-command" accesskey="4">ntpdc command</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">command option (-c)
 171 </td></tr>
 172 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-interactive" accesskey="5">ntpdc interactive</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">interactive option (-i)
 173 </td></tr>
 174 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-listpeers" accesskey="6">ntpdc listpeers</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">listpeers option (-l)
 175 </td></tr>
 176 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-numeric" accesskey="7">ntpdc numeric</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">numeric option (-n)
 177 </td></tr>
 178 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-peers" accesskey="8">ntpdc peers</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">peers option (-p)
 179 </td></tr>
 180 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-showpeers" accesskey="9">ntpdc showpeers</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">showpeers option (-s)
 181 </td></tr>
 182 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-config">ntpdc config</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">presetting/configuring ntpdc
 183 </td></tr>
 184 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-exit-status">ntpdc exit status</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">exit status
 185 </td></tr>
 186 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-Usage">ntpdc Usage</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Usage
 187 </td></tr>
 188 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-See-Also">ntpdc See Also</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">See Also
 189 </td></tr>
 190 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-Authors">ntpdc Authors</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Authors
 191 </td></tr>
 192 <tr><td align="left" valign="top">&bull; <a href="#ntpdc-Bugs">ntpdc Bugs</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Bugs
 193 </td></tr>
 194 </table>
 195
 196 <hr>
 197 <a name="ntpdc-usage"></a>
 198 <div class="header">
 199 <p>
 200 Next: <a href="#ntpdc-ipv4" accesskey="n" rel="next">ntpdc ipv4</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 201 </div>
 202 <a name="ntpdc-help_002fusage-_0028_002d_002dhelp_0029"></a>
 203 <h4 class="subsection">1.1.1 ntpdc help/usage (<samp>--help</samp>)</h4>
 204 <a name="index-ntpdc-help"></a>
 205
 206 <p>This is the automatically generated usage text for ntpdc.
 207 </p>
 208 <p>The text printed is the same whether selected with the <code>help</code> option
 209 (<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>).  <code>more-help</code> will print
 210 the usage text by passing it through a pager program.
 211 <code>more-help</code> is disabled on platforms without a working
 212 <code>fork(2)</code> function.  The <code>PAGER</code> environment variable is
 213 used to select the program, defaulting to <samp>more</samp>.  Both will exit
 214 with a status code of 0.
 215 </p>
 216 <div class="example">
 217 <pre class="example">ntpdc - vendor-specific NTPD control program - Ver. 4.2.8p14
 218 Usage:  ntpdc [ -&lt;flag&gt; [&lt;val&gt;] | --&lt;name&gt;[{=| }&lt;val&gt;] ]... [ host ...]
 219   Flg Arg Option-Name    Description
 220    -4 no  ipv4           Force IPv4 DNS name resolution
 221                                 - prohibits the option 'ipv6'
 222    -6 no  ipv6           Force IPv6 DNS name resolution
 223                                 - prohibits the option 'ipv4'
 224    -c Str command        run a command and exit
 225                                 - may appear multiple times
 226    -d no  debug-level    Increase debug verbosity level
 227                                 - may appear multiple times
 228    -D Num set-debug-level Set the debug verbosity level
 229                                 - may appear multiple times
 230    -i no  interactive    Force ntpq to operate in interactive mode
 231                                 - prohibits these options:
 232                                 command
 233                                 listpeers
 234                                 peers
 235                                 showpeers
 236    -l no  listpeers      Print a list of the peers
 237                                 - prohibits the option 'command'
 238    -n no  numeric        numeric host addresses
 239    -p no  peers          Print a list of the peers
 240                                 - prohibits the option 'command'
 241    -s no  showpeers      Show a list of the peers
 242                                 - prohibits the option 'command'
 243       opt version        output version information and exit
 244    -? no  help           display extended usage information and exit
 245    -! no  more-help      extended usage information passed thru pager
 246    -&gt; opt save-opts      save the option state to a config file
 247    -&lt; Str load-opts      load options from a config file
 248                                 - disabled as '--no-load-opts'
 249                                 - may appear multiple times
 250
 251 Options are specified by doubled hyphens and their name or by a single
 252 hyphen and the flag character.
 253
 254
 255 The following option preset mechanisms are supported:
 256  - reading file $HOME/.ntprc
 257  - reading file ./.ntprc
 258  - examining environment variables named NTPDC_*
 259
 260 Please send bug reports to:  &lt;http://bugs.ntp.org, bugs@ntp.org&gt;
 261 </pre></div>
 262
 263 <hr>
 264 <a name="ntpdc-ipv4"></a>
 265 <div class="header">
 266 <p>
 267 Next: <a href="#ntpdc-ipv6" accesskey="n" rel="next">ntpdc ipv6</a>, Previous: <a href="#ntpdc-usage" accesskey="p" rel="prev">ntpdc usage</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 268 </div>
 269 <a name="ipv4-option-_0028_002d4_0029"></a>
 270 <h4 class="subsection">1.1.2 ipv4 option (-4)</h4>
 271 <a name="index-ntpdc_002dipv4"></a>
 272
 273 <p>This is the &ldquo;force ipv4 dns name resolution&rdquo; option.
 274 </p>
 275 <p>This option has some usage constraints.  It:
 276 </p><ul>
 277 <li> must not appear in combination with any of the following options:
 278 ipv6.
 279 </li></ul>
 280
 281 <p>Force DNS resolution of following host names on the command line
 282 to the IPv4 namespace.
 283 </p><hr>
 284 <a name="ntpdc-ipv6"></a>
 285 <div class="header">
 286 <p>
 287 Next: <a href="#ntpdc-command" accesskey="n" rel="next">ntpdc command</a>, Previous: <a href="#ntpdc-ipv4" accesskey="p" rel="prev">ntpdc ipv4</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 288 </div>
 289 <a name="ipv6-option-_0028_002d6_0029"></a>
 290 <h4 class="subsection">1.1.3 ipv6 option (-6)</h4>
 291 <a name="index-ntpdc_002dipv6"></a>
 292
 293 <p>This is the &ldquo;force ipv6 dns name resolution&rdquo; option.
 294 </p>
 295 <p>This option has some usage constraints.  It:
 296 </p><ul>
 297 <li> must not appear in combination with any of the following options:
 298 ipv4.
 299 </li></ul>
 300
 301 <p>Force DNS resolution of following host names on the command line
 302 to the IPv6 namespace.
 303 </p><hr>
 304 <a name="ntpdc-command"></a>
 305 <div class="header">
 306 <p>
 307 Next: <a href="#ntpdc-interactive" accesskey="n" rel="next">ntpdc interactive</a>, Previous: <a href="#ntpdc-ipv6" accesskey="p" rel="prev">ntpdc ipv6</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 308 </div>
 309 <a name="command-option-_0028_002dc_0029"></a>
 310 <h4 class="subsection">1.1.4 command option (-c)</h4>
 311 <a name="index-ntpdc_002dcommand"></a>
 312
 313 <p>This is the &ldquo;run a command and exit&rdquo; option.
 314 This option takes a string argument <samp>cmd</samp>.
 315 </p>
 316 <p>This option has some usage constraints.  It:
 317 </p><ul>
 318 <li> may appear an unlimited number of times.
 319 </li></ul>
 320
 321 <p>The following argument is interpreted as an interactive format command
 322 and is added to the list of commands to be executed on the specified
 323 host(s).
 324 </p><hr>
 325 <a name="ntpdc-interactive"></a>
 326 <div class="header">
 327 <p>
 328 Next: <a href="#ntpdc-listpeers" accesskey="n" rel="next">ntpdc listpeers</a>, Previous: <a href="#ntpdc-command" accesskey="p" rel="prev">ntpdc command</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 329 </div>
 330 <a name="interactive-option-_0028_002di_0029"></a>
 331 <h4 class="subsection">1.1.5 interactive option (-i)</h4>
 332 <a name="index-ntpdc_002dinteractive"></a>
 333
 334 <p>This is the &ldquo;force ntpq to operate in interactive mode&rdquo; option.
 335 </p>
 336 <p>This option has some usage constraints.  It:
 337 </p><ul>
 338 <li> must not appear in combination with any of the following options:
 339 command, listpeers, peers, showpeers.
 340 </li></ul>
 341
 342 <p>Force ntpq to operate in interactive mode.  Prompts will be written
 343 to the standard output and commands read from the standard input.
 344 </p><hr>
 345 <a name="ntpdc-listpeers"></a>
 346 <div class="header">
 347 <p>
 348 Next: <a href="#ntpdc-numeric" accesskey="n" rel="next">ntpdc numeric</a>, Previous: <a href="#ntpdc-interactive" accesskey="p" rel="prev">ntpdc interactive</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 349 </div>
 350 <a name="listpeers-option-_0028_002dl_0029"></a>
 351 <h4 class="subsection">1.1.6 listpeers option (-l)</h4>
 352 <a name="index-ntpdc_002dlistpeers"></a>
 353
 354 <p>This is the &ldquo;print a list of the peers&rdquo; option.
 355 </p>
 356 <p>This option has some usage constraints.  It:
 357 </p><ul>
 358 <li> must not appear in combination with any of the following options:
 359 command.
 360 </li></ul>
 361
 362 <p>Print a list of the peers known to the server as well as a summary of
 363 their state. This is equivalent to the &rsquo;listpeers&rsquo; interactive command.
 364 </p><hr>
 365 <a name="ntpdc-numeric"></a>
 366 <div class="header">
 367 <p>
 368 Next: <a href="#ntpdc-peers" accesskey="n" rel="next">ntpdc peers</a>, Previous: <a href="#ntpdc-listpeers" accesskey="p" rel="prev">ntpdc listpeers</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 369 </div>
 370 <a name="numeric-option-_0028_002dn_0029"></a>
 371 <h4 class="subsection">1.1.7 numeric option (-n)</h4>
 372 <a name="index-ntpdc_002dnumeric"></a>
 373
 374 <p>This is the &ldquo;numeric host addresses&rdquo; option.
 375 Output all host addresses in dotted-quad numeric format rather than
 376 converting to the canonical host names.
 377 </p><hr>
 378 <a name="ntpdc-peers"></a>
 379 <div class="header">
 380 <p>
 381 Next: <a href="#ntpdc-showpeers" accesskey="n" rel="next">ntpdc showpeers</a>, Previous: <a href="#ntpdc-numeric" accesskey="p" rel="prev">ntpdc numeric</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 382 </div>
 383 <a name="peers-option-_0028_002dp_0029"></a>
 384 <h4 class="subsection">1.1.8 peers option (-p)</h4>
 385 <a name="index-ntpdc_002dpeers"></a>
 386
 387 <p>This is the &ldquo;print a list of the peers&rdquo; option.
 388 </p>
 389 <p>This option has some usage constraints.  It:
 390 </p><ul>
 391 <li> must not appear in combination with any of the following options:
 392 command.
 393 </li></ul>
 394
 395 <p>Print a list of the peers known to the server as well as a summary
 396 of their state. This is equivalent to the &rsquo;peers&rsquo; interactive command.
 397 </p><hr>
 398 <a name="ntpdc-showpeers"></a>
 399 <div class="header">
 400 <p>
 401 Next: <a href="#ntpdc-config" accesskey="n" rel="next">ntpdc config</a>, Previous: <a href="#ntpdc-peers" accesskey="p" rel="prev">ntpdc peers</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 402 </div>
 403 <a name="showpeers-option-_0028_002ds_0029"></a>
 404 <h4 class="subsection">1.1.9 showpeers option (-s)</h4>
 405 <a name="index-ntpdc_002dshowpeers"></a>
 406
 407 <p>This is the &ldquo;show a list of the peers&rdquo; option.
 408 </p>
 409 <p>This option has some usage constraints.  It:
 410 </p><ul>
 411 <li> must not appear in combination with any of the following options:
 412 command.
 413 </li></ul>
 414
 415 <p>Print a list of the peers known to the server as well as a summary
 416 of their state. This is equivalent to the &rsquo;dmpeers&rsquo; interactive command.
 417 </p>
 418
 419 <hr>
 420 <a name="ntpdc-config"></a>
 421 <div class="header">
 422 <p>
 423 Next: <a href="#ntpdc-exit-status" accesskey="n" rel="next">ntpdc exit status</a>, Previous: <a href="#ntpdc-showpeers" accesskey="p" rel="prev">ntpdc showpeers</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 424 </div>
 425 <a name="presetting_002fconfiguring-ntpdc"></a>
 426 <h4 class="subsection">1.1.10 presetting/configuring ntpdc</h4>
 427
 428 <p>Any option that is not marked as <i>not presettable</i> may be preset by
 429 loading values from configuration (&quot;rc&quot; or &quot;ini&quot;) 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
 430 the options listed above in upper case and segmented with underscores.
 431 The <code>NTPDC</code> variable will be tokenized and parsed like
 432 the command line.  The remaining variables are tested for existence and their
 433 values are treated like option arguments.
 434 </p>
 435
 436 <p><code>libopts</code> will search in 2 places for configuration files:
 437 </p><ul>
 438 <li> $HOME
 439 </li><li> $PWD
 440 </li></ul>
 441 <p>The environment variables <code>HOME</code>, and <code>PWD</code>
 442 are expanded and replaced when <samp>ntpdc</samp> runs.
 443 For any of these that are plain files, they are simply processed.
 444 For any that are directories, then a file named <samp>.ntprc</samp> is searched for
 445 within that directory and processed.
 446 </p>
 447 <p>Configuration files may be in a wide variety of formats.
 448 The basic format is an option name followed by a value (argument) on the
 449 same line.  Values may be separated from the option name with a colon,
 450 equal sign or simply white space.  Values may be continued across multiple
 451 lines by escaping the newline with a backslash.
 452 </p>
 453 <p>Multiple programs may also share the same initialization file.
 454 Common options are collected at the top, followed by program specific
 455 segments.  The segments are separated by lines like:
 456 </p><div class="example">
 457 <pre class="example">[NTPDC]
 458 </pre></div>
 459 <p>or by
 460 </p><div class="example">
 461 <pre class="example">&lt;?program ntpdc&gt;
 462 </pre></div>
 463 <p>Do not mix these styles within one configuration file.
 464 </p>
 465 <p>Compound values and carefully constructed string values may also be
 466 specified using XML syntax:
 467 </p><div class="example">
 468 <pre class="example">&lt;option-name&gt;
 469    &lt;sub-opt&gt;...&amp;lt;...&amp;gt;...&lt;/sub-opt&gt;
 470 &lt;/option-name&gt;
 471 </pre></div>
 472 <p>yielding an <code>option-name.sub-opt</code> string value of
 473 </p><div class="example">
 474 <pre class="example">&quot;...&lt;...&gt;...&quot;
 475 </pre></div>
 476 <p><code>AutoOpts</code> does not track suboptions.  You simply note that it is a
 477 hierarchicly valued option.  <code>AutoOpts</code> does provide a means for searching
 478 the associated name/value pair list (see: optionFindValue).
 479 </p>
 480 <p>The command line options relating to configuration and/or usage help are:
 481 </p>
 482 <a name="version-_0028_002d_0029"></a>
 483 <h4 class="subsubheading">version (-)</h4>
 484
 485 <p>Print the program version to standard out, optionally with licensing
 486 information, then exit 0.  The optional argument specifies how much licensing
 487 detail to provide.  The default is to print just the version.  The licensing infomation may be selected with an option argument.
 488 Only the first letter of the argument is examined:
 489 </p>
 490 <dl compact="compact">
 491 <dt>&lsquo;<samp>version</samp>&rsquo;</dt>
 492 <dd><p>Only print the version.  This is the default.
 493 </p></dd>
 494 <dt>&lsquo;<samp>copyright</samp>&rsquo;</dt>
 495 <dd><p>Name the copyright usage licensing terms.
 496 </p></dd>
 497 <dt>&lsquo;<samp>verbose</samp>&rsquo;</dt>
 498 <dd><p>Print the full copyright usage licensing terms.
 499 </p></dd>
 500 </dl>
 501
 502 <hr>
 503 <a name="ntpdc-exit-status"></a>
 504 <div class="header">
 505 <p>
 506 Next: <a href="#ntpdc-Usage" accesskey="n" rel="next">ntpdc Usage</a>, Previous: <a href="#ntpdc-config" accesskey="p" rel="prev">ntpdc config</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 507 </div>
 508 <a name="ntpdc-exit-status-1"></a>
 509 <h4 class="subsection">1.1.11 ntpdc exit status</h4>
 510
 511 <p>One of the following exit values will be returned:
 512 </p><dl compact="compact">
 513 <dt>&lsquo;<samp>0 (EXIT_SUCCESS)</samp>&rsquo;</dt>
 514 <dd><p>Successful program execution.
 515 </p></dd>
 516 <dt>&lsquo;<samp>1 (EXIT_FAILURE)</samp>&rsquo;</dt>
 517 <dd><p>The operation failed or the command syntax was not valid.
 518 </p></dd>
 519 <dt>&lsquo;<samp>66 (EX_NOINPUT)</samp>&rsquo;</dt>
 520 <dd><p>A specified configuration file could not be loaded.
 521 </p></dd>
 522 <dt>&lsquo;<samp>70 (EX_SOFTWARE)</samp>&rsquo;</dt>
 523 <dd><p>libopts had an internal operational error.  Please report
 524 it to autogen-users@lists.sourceforge.net.  Thank you.
 525 </p></dd>
 526 </dl>
 527 <hr>
 528 <a name="ntpdc-Usage"></a>
 529 <div class="header">
 530 <p>
 531 Next: <a href="#ntpdc-See-Also" accesskey="n" rel="next">ntpdc See Also</a>, Previous: <a href="#ntpdc-exit-status" accesskey="p" rel="prev">ntpdc exit status</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 532 </div>
 533 <a name="ntpdc-Usage-1"></a>
 534 <h4 class="subsection">1.1.12 ntpdc Usage</h4>
 535 <hr>
 536 <a name="ntpdc-See-Also"></a>
 537 <div class="header">
 538 <p>
 539 Next: <a href="#ntpdc-Authors" accesskey="n" rel="next">ntpdc Authors</a>, Previous: <a href="#ntpdc-Usage" accesskey="p" rel="prev">ntpdc Usage</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 540 </div>
 541 <a name="ntpdc-See-Also-1"></a>
 542 <h4 class="subsection">1.1.13 ntpdc See Also</h4>
 543 <hr>
 544 <a name="ntpdc-Authors"></a>
 545 <div class="header">
 546 <p>
 547 Next: <a href="#ntpdc-Bugs" accesskey="n" rel="next">ntpdc Bugs</a>, Previous: <a href="#ntpdc-See-Also" accesskey="p" rel="prev">ntpdc See Also</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 548 </div>
 549 <a name="ntpdc-Authors-1"></a>
 550 <h4 class="subsection">1.1.14 ntpdc Authors</h4>
 551 <hr>
 552 <a name="ntpdc-Bugs"></a>
 553 <div class="header">
 554 <p>
 555 Previous: <a href="#ntpdc-Authors" accesskey="p" rel="prev">ntpdc Authors</a>, Up: <a href="#ntpdc-Invocation" accesskey="u" rel="up">ntpdc Invocation</a> &nbsp; </p>
 556 </div>
 557 <a name="ntpdc-Bugs-1"></a>
 558 <h4 class="subsection">1.1.15 ntpdc Bugs</h4>
 559
 560 <hr>
 561 <a name="Usage"></a>
 562 <div class="header">
 563 <p>
 564 Previous: <a href="#ntpdc-Invocation" accesskey="p" rel="prev">ntpdc Invocation</a>, Up: <a href="#ntpdc-Description" accesskey="u" rel="up">ntpdc Description</a> &nbsp; </p>
 565 </div>
 566 <a name="Usage-1"></a>
 567 <h3 class="section">1.2 Usage</h3>
 568
 569 <p>The simplest use of this program is as an unprivileged command to
 570 check the current time, offset, and error in the local clock.
 571 For example:
 572 </p>
 573 <div class="example">
 574 <pre class="example">ntpdc ntpserver.somewhere
 575 </pre></div>
 576
 577 <p>With suitable privilege, it can be run as a command or in a
 578 <code>cron</code> job to reset the local clock from a reliable server, like
 579 the <code>ntpdate</code> and <code>rdate</code> commands.
 580 For example:
 581 </p>
 582 <div class="example">
 583 <pre class="example">ntpdc -a ntpserver.somewhere
 584 </pre></div>
 585 <hr>
 586
 587
 588
 589 </body>
 590 </html>