4 @cindex standard NTP query program
7 # EDIT THIS FILE WITH CAUTION (invoke-ntpq.texi)
9 # It has been AutoGen-ed April 7, 2015 at 04:27:07 AM by AutoGen 5.18.5pre4
10 # From the definitions ntpq-opts.def
11 # and the template file agtexi-cmd.tpl
17 utility program is used to query NTP servers which
18 implement the standard NTP mode 6 control message formats defined
19 in Appendix B of the NTPv3 specification RFC1305, requesting
20 information about current state and/or changes in that state.
21 The same formats are used in NTPv4, although some of the
22 variables have changed and new ones added. The description on this
23 page is for the NTPv4 variables.
24 The program may be run either in interactive mode or controlled using
25 command line arguments.
26 Requests to read and write arbitrary
27 variables can be assembled, with raw and pretty-printed output
28 options being available.
31 utility can also obtain and print a
32 list of peers in a common format by sending multiple queries to the
35 If one or more request options is included on the command line
38 is executed, each of the requests will be sent
39 to the NTP servers running on each of the hosts given as command
40 line arguments, or on localhost by default.
44 will attempt to read commands from the
45 standard input and execute these on the NTP server running on the
46 first host given on the command line, again defaulting to localhost
47 when no other host is specified.
50 utility will prompt for
51 commands if the standard input is a terminal device.
54 uses NTP mode 6 packets to communicate with the
55 NTP server, and hence can be used to query any compatible server on
56 the network which permits it.
57 Note that since NTP is a UDP protocol
58 this communication will be somewhat unreliable, especially over
59 large distances in terms of network topology.
63 one attempt to retransmit requests, and will time requests out if
64 the remote host is not heard from within a suitable timeout
68 command line option other than
73 cause the specified query (queries) to be sent to the indicated
78 interactive format commands from the standard input.
79 @subsubsection Internal Commands
80 Interactive format commands consist of a keyword followed by zero
82 Only enough characters of the full keyword to
83 uniquely identify the command need be typed.
86 number of interactive format commands are executed entirely within
89 utility itself and do not result in NTP mode 6
90 requests being sent to a server.
91 These are described following.
93 @item @code{?} @code{[@kbd{command_keyword}]}
94 @item @code{help} @code{[@kbd{command_keyword}]}
96 @quoteleft{}?@quoteright{}
97 by itself will print a list of all the command
98 keywords known to this incarnation of
101 @quoteleft{}?@quoteright{}
102 followed by a command keyword will print function and usage
103 information about the command.
104 This command is probably a better
105 source of information about
109 @item @code{addvars} @kbd{variable_name}@code{[@code{=value}]} @code{...}
110 @item @code{rmvars} @kbd{variable_name} @code{...}
111 @item @code{clearvars}
112 @item @code{showvars}
113 The data carried by NTP mode 6 messages consists of a list of
115 @quoteleft{}variable_name=value@quoteright{},
117 @quoteleft{}=value@quoteright{}
118 is ignored, and can be omitted,
119 in requests to the server to read variables.
122 utility maintains an internal list in which data to be included in control
123 messages can be assembled, and sent using the
127 commands described below.
130 command allows variables and their optional values to be added to
132 If more than one variable is to be added, the list should
133 be comma-separated and not contain white space.
136 command can be used to remove individual variables from the list,
139 command removes all variables from the
143 command displays the current list of optional variables.
144 @item @code{authenticate} @code{[yes | no]}
147 does not authenticate requests unless
148 they are write requests.
150 @quoteleft{}authenticate yes@quoteright{}
153 to send authentication with all requests it
155 Authenticated requests causes some servers to handle
156 requests slightly differently, and can occasionally melt the CPU in
157 fuzzballs if you turn authentication on before doing a
161 @quoteleft{}authenticate@quoteright{}
164 to display whether or not
166 is currently autheinticating requests.
168 Causes output from query commands to be "cooked", so that
169 variables which are recognized by
172 values reformatted for human consumption.
175 thinks should have a decodable value but didn't are
176 marked with a trailing
177 @quoteleft{}?@quoteright{}.
178 @item @code{debug} @code{[@code{more} | @code{less} | @code{off}]}
179 With no argument, displays the current debug level.
180 Otherwise, the debug level is changed to the indicated level.
181 @item @code{delay} @kbd{milliseconds}
182 Specify a time interval to be added to timestamps included in
183 requests which require authentication.
184 This is used to enable
185 (unreliable) server reconfiguration over long delay network paths
186 or between machines whose clocks are unsynchronized.
188 server does not now require timestamps in authenticated requests,
189 so this command may be obsolete.
193 @item @code{host} @kbd{hostname}
194 Set the host to which future queries will be sent.
196 may be either a host name or a numeric address.
197 @item @code{hostnames} @code{[@code{yes} | @code{no}]}
200 is specified, host names are printed in
201 information displays.
204 is specified, numeric
205 addresses are printed instead.
209 modified using the command line
212 @item @code{keyid} @kbd{keyid}
213 This command allows the specification of a key number to be
214 used to authenticate configuration requests.
216 to a key number the server has been configured to use for this
218 @item @code{keytype} @code{[@code{md5} | @code{OpenSSLDigestType}]}
219 Specify the type of key to use for authenticating requests.
224 was built with OpenSSL support,
225 any digest type supported by OpenSSL can also be provided.
226 If no argument is given, the current
229 @item @code{ntpversion} @code{[@code{1} | @code{2} | @code{3} | @code{4}]}
230 Sets the NTP version number which
234 Defaults to 3, and note that mode 6 control messages (and
235 modes, for that matter) didn't exist in NTP version 1.
237 to be no servers left which demand version 1.
238 With no argument, displays the current NTP version that will be used
239 when communicating with servers.
241 This command prompts you to type in a password (which will not
242 be echoed) which will be used to authenticate configuration
244 The password must correspond to the key configured for
245 use by the NTP server for this purpose if such requests are to be
254 Causes all output from query commands is printed as received
255 from the remote server.
256 The only formating/interpretation done on
257 the data is to transform nonascii data into a printable (but barely
258 understandable) form.
259 @item @code{timeout} @kbd{milliseconds}
260 Specify a timeout period for responses to server queries.
262 default is about 5000 milliseconds.
265 retries each query once after a timeout, the total waiting time for
266 a timeout will be twice the timeout value set.
268 Print the version of the
273 @subsubsection Control Message Commands
274 Association IDs are used to identify system, peer and clock variables.
275 System variables are assigned an association ID of zero and system name space, while each association is assigned a nonzero association ID and peer namespace.
276 Most control commands send a single mode-6 message to the server and expect a single response message.
277 The exceptions are the
279 command, which sends a series of messages,
284 commands, which iterate over a range of associations.
286 @item @code{associations}
287 Display a list of mobilized associations in the form:
289 ind assid status conf reach auth condition last_event cnt
292 @item Sy String Ta Sy Description
293 @item @code{ind} @code{Ta} @code{index} @code{on} @code{this} @code{list}
294 @item @code{assid} @code{Ta} @code{association} @code{ID}
295 @item @code{status} @code{Ta} @code{peer} @code{status} @code{word}
296 @item @code{conf} @code{Ta} @code{yes}: @code{persistent,} @code{no}: @code{ephemeral}
297 @item @code{reach} @code{Ta} @code{yes}: @code{reachable,} @code{no}: @code{unreachable}
298 @item @code{auth} @code{Ta} @code{ok}, @code{yes}, @code{bad} @code{and} @code{none}
299 @item @code{condition} @code{Ta} @code{selection} @code{status} @code{(see} @code{the} @code{select} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
300 @item @code{last_event} @code{Ta} @code{event} @code{report} @code{(see} @code{the} @code{event} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
301 @item @code{cnt} @code{Ta} @code{event} @code{count} @code{(see} @code{the} @code{count} @code{field} @code{of} @code{the} @code{peer} @code{status} @code{word)}
303 @item @code{authinfo}
304 Display the authentication statistics.
305 @item @code{clockvar} @kbd{assocID} @code{[@kbd{name}@code{[@code{=}@kbd{value}]}]} @code{[...]}
306 @item @code{cv} @kbd{assocID} @code{[@kbd{name}@code{[@code{=}@kbd{value}]}]} @code{[...]}
307 Display a list of clock variables for those associations supporting a reference clock.
308 @item @code{:config} @code{[...]}
309 Send the remainder of the command line, including whitespace, to the server as a run-time configuration command in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is of course required.
310 @item @code{config-from-file} @kbd{filename}
311 Send the each line of
313 to the server as run-time configuration commands in the same format as a line in the configuration file. This command is experimental until further notice and clarification. Authentication is required.
315 Display statistics for each local network address. Authentication is required.
317 Display network and reference clock I/O statistics.
318 @item @code{kerninfo}
319 Display kernel loop and PPS statistics. As with other ntpq output, times are in milliseconds. The precision value displayed is in milliseconds as well, unlike the precision system variable.
320 @item @code{lassociations}
321 Perform the same function as the associations command, except display mobilized and unmobilized associations.
322 @item @code{lopeers} @code{[@code{-4} | @code{-6}]}
323 Obtain and print a list of all peers and clients showing
325 (associated with any given IP version).
326 @item @code{lpeers} @code{[@code{-4} | @code{-6}]}
327 Print a peer spreadsheet for the appropriate IP version(s).
329 (associated with any given IP version).
330 @item @code{monstats}
331 Display monitor facility statistics.
332 @item @code{mrulist} @code{[@code{limited} | @code{kod} | @code{mincount}=@kbd{count} | @code{laddr}=@kbd{localaddr} | @code{sort}=@kbd{sortorder} | @code{resany}=@kbd{hexmask} | @code{resall}=@kbd{hexmask}]}
333 Obtain and print traffic counts collected and maintained by the monitor facility.
334 With the exception of
335 @code{sort}=@kbd{sortorder},
336 the options filter the list returned by
342 options return only entries representing client addresses from which the last packet received triggered either discarding or a KoD response.
344 @code{mincount}=@kbd{count}
345 option filters entries representing less than
349 @code{laddr}=@kbd{localaddr}
350 option filters entries for packets received on any local address other than
352 @code{resany}=@kbd{hexmask}
354 @code{resall}=@kbd{hexmask}
355 filter entries containing none or less than all, respectively, of the bits in
357 which must begin with
368 or any of those preceded by a minus sign (hyphen) to reverse the sort order.
369 The output columns are:
374 Interval in s between the receipt of the most recent packet from this address and the completion of the retrieval of the MRU list by
377 Average interval in s between packets from this address.
379 Restriction flags associated with this address.
380 Most are copied unchanged from the matching
382 command, however 0x400 (kod) and 0x20 (limited) flags are cleared unless the last packet from this address triggered a rate control response.
384 Rate control indicator, either
389 for no rate control response,
390 rate limiting by discarding, or rate limiting with a KoD response, respectively.
394 Packet version number.
396 Packets received from this address.
398 Source port of last packet from this address.
399 @item @code{remote} @code{address}
400 DNS name, numeric address, or address followed by
401 claimed DNS name which could not be verified in parentheses.
403 @item @code{mreadvar} @code{assocID} @code{assocID} @code{[@kbd{variable_name}@code{[=@kbd{value}]} ...]}
404 @item @code{mrv} @code{assocID} @code{assocID} @code{[@kbd{variable_name}@code{[=@kbd{value}]} ...]}
405 Perform the same function as the
407 command, except for a range of association IDs.
408 This range is determined from the association list cached by the most recent
411 @item @code{opeers} @code{[@code{-4} | @code{-6}]}
412 Obtain and print the old-style list of all peers and clients showing
414 (associated with any given IP version),
417 @item @code{passociations}
418 Perform the same function as the
421 except that it uses previously stored data rather than making a new query.
423 Display a list of peers in the form:
425 [tally]remote refid st t when pool reach delay offset jitter
431 single-character code indicating current value of the
434 .Lk decode.html#peer "peer status word"
436 host name (or IP number) of peer.
437 The value displayed will be truncated to 15 characters unless the
439 flag is given, in which case the full value will be displayed
441 and the remaining data is displayed on the next line.
444 .Lk decode.html#kiss "'kiss code"
449 unicast or manycast client,
451 broadcast or multicast client,
453 local (reference clock),
463 sec/min/hr since last received packet
465 poll interval (log2 s)
467 reach shift register (octal)
471 offset of server relative to this host
475 @item @code{pstats} @kbd{assocID}
476 Show the statistics for the peer with the given
478 @item @code{readlist} @kbd{assocID}
479 @item @code{rl} @kbd{assocID}
480 Read the system or peer variables included in the variable list.
481 @item @code{readvar} @kbd{assocID} @kbd{name}@code{[=@kbd{value}]} @code{[, ...]}
482 @item @code{rv} @kbd{assocID} @kbd{name}@code{[=@kbd{value}]} @code{[, ...]}
483 Display the specified variables.
486 is zero, the variables are from the
487 @ref{System Variables}
488 name space, otherwise they are from the
493 is required, as the same name can occur in both spaces.
496 is included, all operative variables in the name space are displayed.
498 In this case only, if the
500 is omitted, it is assumed zero.
501 Multiple names are specified with comma separators and without whitespace.
502 Note that time values are represented in milliseconds
503 and frequency values in parts-per-million (PPM).
504 Some NTP timestamps are represented in the format
506 where YYYY is the year,
507 MM the month of year,
508 DD the day of month and
509 TTTT the time of day.
511 Show the access control (restrict) list for
514 @item @code{saveconfig} @kbd{filename}
515 Write the current configuration,
516 including any runtime modifications given with
519 @code{config-from-file},
520 to the ntpd host's file
522 This command will be rejected by the server unless
523 .Lk miscopt.html#saveconfigdir "saveconfigdir"
530 format specifies to substitute the current date and time, for example,
531 @code{q]saveconfig} @code{ntp-%Y%m%d-%H%M%S.confq]}.
532 The filename used is stored in system variable
534 Authentication is required.
535 @item @code{timerstats}
536 Display interval timer counters.
537 @item @code{writelist} @kbd{assocID}
538 Write the system or peer variables included in the variable list.
539 @item @code{writevar} @kbd{assocID} @kbd{name}=@kbd{value} @code{[, ...]}
540 Write the specified variables.
543 is zero, the variables are from the
544 @ref{System Variables}
545 name space, otherwise they are from the
550 is required, as the same name can occur in both spaces.
552 Display operational summary.
553 @item @code{sysstats}
554 Print statistics counters maintained in the protocol module.
557 @subsubsection Status Words and Kiss Codes
559 The current state of the operating program is shown
560 in a set of status words
561 maintained by the system.
562 Status information is also available on a per-association basis.
563 These words are displayed in the
567 commands both in hexadecimal and in decoded short tip strings.
568 The codes, tips and short explanations are documented on the
569 .Lk decode.html "Event Messages and Status Words"
571 The page also includes a list of system and peer messages,
572 the code for the latest of which is included in the status word.
574 Information resulting from protocol machine state transitions
575 is displayed using an informal set of ASCII strings called
576 .Lk decode.html#kiss "kiss codes" .
577 The original purpose was for kiss-o'-death (KoD) packets
578 sent by the server to advise the client of an unusual condition.
579 They are now displayed, when appropriate,
580 in the reference identifier field in various billboards.
582 @subsubsection System Variables
583 The following system variables appear in the
586 Not all variables are displayed in some configurations.
591 .Lk decode.html#sys "system status word"
593 NTP software version and build time
594 @item @code{processor}
595 hardware platform and version
597 operating system and version
599 leap warning indicator (0-3)
602 @item @code{precision}
604 @item @code{rootdelay}
605 total roundtrip delay to the primary reference clock
606 @item @code{rootdisp}
607 total dispersion to the primary reference clock
609 system peer association ID
611 time constant and poll exponent (log2 s) (3-17)
613 minimum time constant (log2 s) (3-10)
618 .Lk decode.html#kiss "kiss code"
622 combined offset of server relative to this host
623 @item @code{sys_jitter}
624 combined system jitter
625 @item @code{frequency}
626 frequency offset (PPM) relative to hardware clock
627 @item @code{clk_wander}
628 clock frequency wander (PPM)
629 @item @code{clk_jitter}
634 NTP seconds when the next leap second is/was inserted
636 NTP seconds when the NIST leapseconds file expires
638 The jitter and wander statistics are exponentially-weighted RMS averages.
639 The system jitter is defined in the NTPv4 specification;
640 the clock jitter statistic is computed by the clock discipline module.
642 When the NTPv4 daemon is compiled with the OpenSSL software library,
643 additional system variables are displayed,
644 including some or all of the following,
645 depending on the particular Autokey dance:
651 Autokey host name for this host
653 Autokey group name for this host
655 host flags (see Autokey specification)
657 OpenSSL message digest algorithm
658 @item @code{signature}
659 OpenSSL digest/signature scheme
661 NTP seconds at last signature update
663 certificate subject, issuer and certificate flags
665 NTP seconds when the certificate expires
667 @subsubsection Peer Variables
668 The following peer variables appear in the
670 billboard for each association.
671 Not all variables are displayed in some configurations.
679 .Lk decode.html#peer "peer status word"
681 source (remote) IP address
685 destination (local) IP address
687 destination (local) port
692 @item @code{precision}
694 @item @code{rootdelay}
695 total roundtrip delay to the primary reference clock
696 @item @code{rootdisp}
697 total root dispersion to the primary reference clock
700 .Lk decode.html#kiss "kiss code"
704 reach register (octal)
712 host poll exponent (log2 s) (3-17)
714 peer poll exponent (log2 s) (3-17)
717 .Lk rate.html "Rate Management and the Kiss-o'-Death Packet" )
719 .Lk decode.html#flash "flash status word"
724 @item @code{dispersion}
729 Autokey group name for this association
731 unicast/broadcast bias
733 interleave delay (see
734 .Lk xleave.html "NTP Interleaved Modes" )
738 variable is calculated when the first broadcast packet is received
739 after the calibration volley.
740 It represents the offset of the broadcast subgraph relative to the unicast subgraph.
743 variable appears only for the interleaved symmetric and interleaved modes.
744 It represents the internal queuing, buffering and transmission delays
745 for the preceding packet.
747 When the NTPv4 daemon is compiled with the OpenSSL software library,
748 additional peer variables are displayed, including the following:
753 peer flags (see Autokey specification)
757 peer flags (see Autokey specification)
758 @item @code{signature}
759 OpenSSL digest/signature scheme
760 @item @code{initsequence}
764 @item @code{timestamp}
765 Autokey signature timestamp
768 @subsubsection Clock Variables
769 The following clock variables appear in the
771 billboard for each association with a reference clock.
772 Not all variables are displayed in some configurations.
779 .Lk decode.html#clock "clock status word"
782 @item @code{timecode}
783 ASCII time code string (specific to device)
788 @item @code{badformat}
792 @item @code{fudgetime1}
794 @item @code{fudgetime2}
804 This section was generated by @strong{AutoGen},
805 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntpq} program.
806 This software is released under the NTP license, <http://ntp.org/license>.
809 * ntpq usage:: ntpq help/usage (@option{--help})
810 * ntpq ipv4:: ipv4 option (-4)
811 * ntpq ipv6:: ipv6 option (-6)
812 * ntpq command:: command option (-c)
813 * ntpq interactive:: interactive option (-i)
814 * ntpq numeric:: numeric option (-n)
815 * ntpq old-rv:: old-rv option
816 * ntpq peers:: peers option (-p)
817 * ntpq wide:: wide option (-w)
818 * ntpq config:: presetting/configuring ntpq
819 * ntpq exit status:: exit status
823 @subsection ntpq help/usage (@option{--help})
826 This is the automatically generated usage text for ntpq.
828 The text printed is the same whether selected with the @code{help} option
829 (@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print
830 the usage text by passing it through a pager program.
831 @code{more-help} is disabled on platforms without a working
832 @code{fork(2)} function. The @code{PAGER} environment variable is
833 used to select the program, defaulting to @file{more}. Both will exit
834 with a status code of 0.
838 ntpq - standard NTP query program - Ver. 4.2.8p2
839 Usage: ntpq [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...]
840 Flg Arg Option-Name Description
841 -4 no ipv4 Force IPv4 DNS name resolution
842 - prohibits the option 'ipv6'
843 -6 no ipv6 Force IPv6 DNS name resolution
844 - prohibits the option 'ipv4'
845 -c Str command run a command and exit
846 - may appear multiple times
847 -d no debug-level Increase debug verbosity level
848 - may appear multiple times
849 -D Num set-debug-level Set the debug verbosity level
850 - may appear multiple times
851 -i no interactive Force ntpq to operate in interactive mode
852 - prohibits these options:
855 -n no numeric numeric host addresses
856 no old-rv Always output status line with readvar
857 -p no peers Print a list of the peers
858 - prohibits the option 'interactive'
859 -w no wide Display the full 'remote' value
860 opt version output version information and exit
861 -? no help display extended usage information and exit
862 -! no more-help extended usage information passed thru pager
863 -> opt save-opts save the option state to a config file
864 -< Str load-opts load options from a config file
865 - disabled as '--no-load-opts'
866 - may appear multiple times
868 Options are specified by doubled hyphens and their name or by a single
869 hyphen and the flag character.
871 The following option preset mechanisms are supported:
872 - reading file $HOME/.ntprc
873 - reading file ./.ntprc
874 - examining environment variables named NTPQ_*
876 Please send bug reports to: <http://bugs.ntp.org, bugs@@ntp.org>
881 @subsection ipv4 option (-4)
884 This is the ``force ipv4 dns name resolution'' option.
887 This option has some usage constraints. It:
890 must not appear in combination with any of the following options:
894 Force DNS resolution of following host names on the command line
895 to the IPv4 namespace.
897 @subsection ipv6 option (-6)
900 This is the ``force ipv6 dns name resolution'' option.
903 This option has some usage constraints. It:
906 must not appear in combination with any of the following options:
910 Force DNS resolution of following host names on the command line
911 to the IPv6 namespace.
913 @subsection command option (-c)
916 This is the ``run a command and exit'' option.
917 This option takes a string argument @file{cmd}.
920 This option has some usage constraints. It:
923 may appear an unlimited number of times.
926 The following argument is interpreted as an interactive format command
927 and is added to the list of commands to be executed on the specified
929 @node ntpq interactive
930 @subsection interactive option (-i)
931 @cindex ntpq-interactive
933 This is the ``force ntpq to operate in interactive mode'' option.
936 This option has some usage constraints. It:
939 must not appear in combination with any of the following options:
943 Force @code{ntpq} to operate in interactive mode.
944 Prompts will be written to the standard output and
945 commands read from the standard input.
947 @subsection numeric option (-n)
950 This is the ``numeric host addresses'' option.
951 Output all host addresses in dotted-quad numeric format rather than
952 converting to the canonical host names.
954 @subsection old-rv option
957 This is the ``always output status line with readvar'' option.
958 By default, @code{ntpq} now suppresses the @code{associd=...}
959 line that precedes the output of @code{readvar}
960 (alias @code{rv}) when a single variable is requested, such as
961 @code{ntpq -c "rv 0 offset"}.
962 This option causes @code{ntpq} to include both lines of output
963 for a single-variable @code{readvar}.
964 Using an environment variable to
965 preset this option in a script will enable both older and
966 newer @code{ntpq} to behave identically in this regard.
968 @subsection peers option (-p)
971 This is the ``print a list of the peers'' option.
974 This option has some usage constraints. It:
977 must not appear in combination with any of the following options:
981 Print a list of the peers known to the server as well as a summary
982 of their state. This is equivalent to the 'peers' interactive command.
984 @subsection wide option (-w)
987 This is the ``display the full 'remote' value'' option.
988 Display the full value of the 'remote' value. If this requires
989 more than 15 characters, display the full value, emit a newline,
990 and continue the data display properly indented on the next line.
994 @subsection presetting/configuring ntpq
996 Any option that is not marked as @i{not presettable} may be preset by
997 loading values from configuration ("rc" or "ini") files, and values from environment variables named @code{NTPQ} and @code{NTPQ_<OPTION_NAME>}. @code{<OPTION_NAME>} must be one of
998 the options listed above in upper case and segmented with underscores.
999 The @code{NTPQ} variable will be tokenized and parsed like
1000 the command line. The remaining variables are tested for existence and their
1001 values are treated like option arguments.
1005 @code{libopts} will search in 2 places for configuration files:
1012 The environment variables @code{HOME}, and @code{PWD}
1013 are expanded and replaced when @file{ntpq} runs.
1014 For any of these that are plain files, they are simply processed.
1015 For any that are directories, then a file named @file{.ntprc} is searched for
1016 within that directory and processed.
1018 Configuration files may be in a wide variety of formats.
1019 The basic format is an option name followed by a value (argument) on the
1020 same line. Values may be separated from the option name with a colon,
1021 equal sign or simply white space. Values may be continued across multiple
1022 lines by escaping the newline with a backslash.
1024 Multiple programs may also share the same initialization file.
1025 Common options are collected at the top, followed by program specific
1026 segments. The segments are separated by lines like:
1036 Do not mix these styles within one configuration file.
1038 Compound values and carefully constructed string values may also be
1039 specified using XML syntax:
1042 <sub-opt>...<...>...</sub-opt>
1046 yielding an @code{option-name.sub-opt} string value of
1050 @code{AutoOpts} does not track suboptions. You simply note that it is a
1051 hierarchicly valued option. @code{AutoOpts} does provide a means for searching
1052 the associated name/value pair list (see: optionFindValue).
1054 The command line options relating to configuration and/or usage help are:
1056 @subsubheading version (-)
1058 Print the program version to standard out, optionally with licensing
1059 information, then exit 0. The optional argument specifies how much licensing
1060 detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument.
1061 Only the first letter of the argument is examined:
1065 Only print the version. This is the default.
1067 Name the copyright usage licensing terms.
1069 Print the full copyright usage licensing terms.
1072 @node ntpq exit status
1073 @subsection ntpq exit status
1075 One of the following exit values will be returned:
1077 @item 0 (EXIT_SUCCESS)
1078 Successful program execution.
1079 @item 1 (EXIT_FAILURE)
1080 The operation failed or the command syntax was not valid.
1081 @item 66 (EX_NOINPUT)
1082 A specified configuration file could not be loaded.
1083 @item 70 (EX_SOFTWARE)
1084 libopts had an internal operational error. Please report
1085 it to autogen-users@@lists.sourceforge.net. Thank you.