EDIT THIS FILE WITH CAUTION (in-mem file)
It has been AutoGen-ed June 6, 2023 at 04:38:01 AM by AutoGen 5.18.16
From the definitions ntpdc-opts.def
and the template file agman-cmd.tpl
[\f\*[B-Font]-flags\f[]] [\f\*[B-Font]-flag\f[] [\f\*[I-Font]value\f[]]] [\f\*[B-Font]--option-name\f[][[=| ]\f\*[I-Font]value\f[]]] [ host ...]
.NOP \f\*[B-Font]-4\f[], \f\*[B-Font]--ipv4\f[] Force IPv4 DNS name resolution. This option must not appear in combination with any of the following options: ipv6. Force DNS resolution of following host names on the command line to the IPv4 namespace.
.NOP \f\*[B-Font]-6\f[], \f\*[B-Font]--ipv6\f[] Force IPv6 DNS name resolution. This option must not appear in combination with any of the following options: ipv4. Force DNS resolution of following host names on the command line to the IPv6 namespace.
.NOP \f\*[B-Font]-c\f[] \f\*[I-Font]cmd\f[], \f\*[B-Font]--command\f[]=\f\*[I-Font]cmd\f[] run a command and exit. This option may appear an unlimited number of times. The following argument is interpreted as an interactive format command and is added to the list of commands to be executed on the specified host(s).
.NOP \f\*[B-Font]-d\f[], \f\*[B-Font]--debug-level\f[] Increase debug verbosity level. This option may appear an unlimited number of times.
.NOP \f\*[B-Font]-D\f[] \f\*[I-Font]number\f[], \f\*[B-Font]--set-debug-level\f[]=\f\*[I-Font]number\f[] Set the debug verbosity level. This option may appear an unlimited number of times. This option takes an integer number as its argument.
.NOP \f\*[B-Font]-i\f[], \f\*[B-Font]--interactive\f[] Force ntpq to operate in interactive mode. This option must not appear in combination with any of the following options: command, listpeers, peers, showpeers. Force ntpq to operate in interactive mode. Prompts will be written to the standard output and commands read from the standard input.
.NOP \f\*[B-Font]-l\f[], \f\*[B-Font]--listpeers\f[] Print a list of the peers. This option must not appear in combination with any of the following options: command. Print a list of the peers known to the server as well as a summary of their state. This is equivalent to the 'listpeers' interactive command.
.NOP \f\*[B-Font]-n\f[], \f\*[B-Font]--numeric\f[] numeric host addresses. Output all host addresses in dotted-quad numeric format rather than converting to the canonical host names.
.NOP \f\*[B-Font]-p\f[], \f\*[B-Font]--peers\f[] Print a list of the peers. This option must not appear in combination with any of the following options: command. Print a list of the peers known to the server as well as a summary of their state. This is equivalent to the 'peers' interactive command.
.NOP \f\*[B-Font]-s\f[], \f\*[B-Font]--showpeers\f[] Show a list of the peers. This option must not appear in combination with any of the following options: command. Print a list of the peers known to the server as well as a summary of their state. This is equivalent to the 'dmpeers' interactive command.
.NOP \f\*[B-Font]-u\f[], \f\*[B-Font]--unconnected\f[] Use unconnected UDP to communicate with ntpd (default on Windows). Open an unconnected UDP association to ntpd (the default on Windows).
.NOP \f\*[B-Font]-?\f[], \f\*[B-Font]--help\f[] Display usage information and exit.
.NOP \f\*[B-Font]-!\f[], \f\*[B-Font]--more-help\f[] Pass the extended usage information through a pager.
.NOP \f\*[B-Font]->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]--save-opts\f[] [=\f\*[I-Font]cfgfile\f[]] Save the option state to cfgfile. The default is the last configuration file listed in the OPTION PRESETS section, below. The command will exit after updating the config file.
.NOP \f\*[B-Font]-<\f[] \f\*[I-Font]cfgfile\f[], \f\*[B-Font]--load-opts\f[]=\f\*[I-Font]cfgfile\f[], \f\*[B-Font]--no-load-opts\f[] Load options from cfgfile. The no-load-opts form will disable the loading of earlier config/rc/ini files. --no-load-opts is handled early, out of order.
.NOP \f\*[B-Font]--version\f[] [{\f\*[I-Font]v|c|n\f[]}] Output version of program and exit. The default mode is `v', a simple version. The `c' mode will print copyright information and `n' will print the full copyright notice.
NTPDC_<option-name> or NTPDCThe environmental presets take precedence (are processed later than) the configuration files. The homerc files are "$HOME", and ".". If any of these are directories, then the file .ntprc is searched for within those directories.
7 .NOP \f\*[B-Font]?\f[] \f\*[I-Font]command_keyword\f[]
7 .NOP \f\*[B-Font]help\f[] \f\*[I-Font]command_keyword\f[] A \[oq]\f\*[B-Font]?\f[]\[cq] will print a list of all the command keywords known to this incarnation of \f\*[B-Font]ntpdc. A \[oq]\f\*[B-Font]?\f[]\[cq] followed by a command keyword will print function and usage information about the command. This command is probably a better source of information about ntpq\f[](1ntpqmdoc)\f[] than this manual page.
7 .NOP \f\*[B-Font]delay\f[] \f\*[I-Font]milliseconds\f[] Specify a time interval to be added to timestamps included in requests which require authentication. This is used to enable (unreliable) server reconfiguration over long delay network paths or between machines whose clocks are unsynchronized. Actually the server does not now require timestamps in authenticated requests, so this command may be obsolete.
7 .NOP \f\*[B-Font]host\f[] \f\*[I-Font]hostname\f[] Set the host to which future queries will be sent. Hostname may be either a host name or a numeric address.
7 .NOP \f\*[B-Font]hostnames\f[] [\f\*[B-Font]yes\f[] | \f\*[B-Font]no\f[]] If \f\*[B-Font]yes\f[] is specified, host names are printed in information displays. If \f\*[B-Font]no\f[] is specified, numeric addresses are printed instead. The default is \f\*[B-Font]yes\f[], unless modified using the command line \f\*[B-Font]-n\f[] switch.
7 .NOP \f\*[B-Font]keyid\f[] \f\*[I-Font]keyid\f[] This command allows the specification of a key number to be used to authenticate configuration requests. This must correspond to a key number the server has been configured to use for this purpose.
7 .NOP \f\*[B-Font]quit\f[] Exit \f\*[B-Font]ntpdc.
7 .NOP \f\*[B-Font]passwd\f[] This command prompts you to type in a password (which will not be echoed) which will be used to authenticate configuration requests. The password must correspond to the key configured for use by the NTP server for this purpose if such requests are to be successful.
7 .NOP \f\*[B-Font]timeout\f[] \f\*[I-Font]milliseconds\f[] Specify a timeout period for responses to server queries. The default is about 8000 milliseconds. Note that since \f\*[B-Font]ntpdc retries each query once after a timeout, the total waiting time for a timeout will be twice the timeout value set.
7 .NOP \f\*[B-Font]listpeers\f[] Obtains and prints a brief list of the peers for which the server is maintaining state. These should include all configured peer associations as well as those peers whose stratum is such that they are considered by the server to be possible future synchronization candidates.
7 .NOP \f\*[B-Font]peers\f[] Obtains a list of peers for which the server is maintaining state, along with a summary of that state. Summary information includes the address of the remote peer, the local interface address (0.0.0.0 if a local address has yet to be determined), the stratum of the remote peer (a stratum of 16 indicates the remote peer is unsynchronized), the polling interval, in seconds, the reachability register, in octal, and the current estimated delay, offset and dispersion of the peer, all in seconds. The character in the left margin indicates the mode this peer entry is operating in. A \[oq]+\[cq] denotes symmetric active, a \[oq]-\[cq] indicates symmetric passive, a \[oq]=\[cq] means the remote server is being polled in client mode, a \[oq]^\[cq] indicates that the server is broadcasting to this address, a \[oq]~\[cq] denotes that the remote peer is sending broadcasts and a \[oq]~\[cq] denotes that the remote peer is sending broadcasts and a \[oq]*\[cq] marks the peer the server is currently synchronizing to. The contents of the host field may be one of four forms. It may be a host name, an IP address, a reference clock implementation name with its parameter or REFCLK\f[]()\f[] On \f\*[B-Font]hostnames\f[] \f\*[B-Font]no\f[] only IP-addresses will be displayed.
7 .NOP \f\*[B-Font]dmpeers\f[] A slightly different peer summary list. Identical to the output of the \f\*[B-Font]peers\f[] command, except for the character in the leftmost column. Characters only appear beside peers which were included in the final stage of the clock selection algorithm. A \[oq].\[cq] indicates that this peer was cast off in the falseticker detection, while a \[oq]+\[cq] indicates that the peer made it through. A \[oq]*\[cq] denotes the peer the server is currently synchronizing with.
7 .NOP \f\*[B-Font]showpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] Shows a detailed display of the current peer variables for one or more peers. Most of these values are described in the NTP Version 2 specification.
7 .NOP \f\*[B-Font]pstats\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] Show per-peer statistic counters associated with the specified peer(s).
7 .NOP \f\*[B-Font]clockstat\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] Obtain and print information concerning a peer clock. The values obtained provide information on the setting of fudge factors and other clock performance information.
7 .NOP \f\*[B-Font]kerninfo\f[] Obtain and print kernel phase-lock loop operating parameters. This information is available only if the kernel has been specially modified for a precision timekeeping function.
7 .NOP \f\*[B-Font]loopinfo\f[] [\f\*[B-Font]oneline\f[] | \f\*[B-Font]multiline\f[]] Print the values of selected loop filter variables. The loop filter is the part of NTP which deals with adjusting the local system clock. The \[oq]offset\[cq] is the last offset given to the loop filter by the packet processing code. The \[oq]frequency\[cq] is the frequency error of the local clock in parts-per-million (ppm). The \[oq]time_const\[cq] controls the stiffness of the phase-lock loop and thus the speed at which it can adapt to oscillator drift. The \[oq]watchdog timer\[cq] value is the number of seconds which have elapsed since the last sample offset was given to the loop filter. The \f\*[B-Font]oneline\f[] and \f\*[B-Font]multiline\f[] options specify the format in which this information is to be printed, with \f\*[B-Font]multiline\f[] as the default.
7 .NOP \f\*[B-Font]sysinfo\f[] Print a variety of system state variables, i.e., state related to the local server. All except the last four lines are described in the NTP Version 3 specification, RFC-1305. The \[oq]system flags\[cq] show various system flags, some of which can be set and cleared by the \f\*[B-Font]enable\f[] and \f\*[B-Font]disable\f[] configuration commands, respectively. These are the \f\*[B-Font]auth\f[], \f\*[B-Font]bclient\f[], \f\*[B-Font]monitor\f[], \f\*[B-Font]pll\f[], \f\*[B-Font]pps\f[] and \f\*[B-Font]stats\f[] flags. See the ntpd\f[](1ntpdmdoc)\f[] documentation for the meaning of these flags. There are two additional flags which are read only, the \f\*[B-Font]kernel_pll\f[] and \f\*[B-Font]kernel_pps\f[]. These flags indicate the synchronization status when the precision time kernel modifications are in use. The \[oq]kernel_pll\[cq] indicates that the local clock is being disciplined by the kernel, while the \[oq]kernel_pps\[cq] indicates the kernel discipline is provided by the PPS signal. The \[oq]stability\[cq] is the residual frequency error remaining after the system frequency correction is applied and is intended for maintenance and debugging. In most architectures, this value will initially decrease from as high as 500 ppm to a nominal value in the range .01 to 0.1 ppm. If it remains high for some time after starting the daemon, something may be wrong with the local clock, or the value of the kernel variable kern.clockrate.tick\f[] may be incorrect. The \[oq]broadcastdelay\[cq] shows the default broadcast delay, as set by the \f\*[B-Font]broadcastdelay\f[] configuration command. The \[oq]authdelay\[cq] shows the default authentication delay, as set by the \f\*[B-Font]authdelay\f[] configuration command.
7 .NOP \f\*[B-Font]sysstats\f[] Print statistics counters maintained in the protocol module.
7 .NOP \f\*[B-Font]memstats\f[] Print statistics counters related to memory allocation code.
7 .NOP \f\*[B-Font]iostats\f[] Print statistics counters maintained in the input-output module.
7 .NOP \f\*[B-Font]timerstats\f[] Print statistics counters maintained in the timer/event queue support code.
7 .NOP \f\*[B-Font]reslist\f[] Obtain and print the server's restriction list. This list is (usually) printed in sorted order and may help to understand how the restrictions are applied.
7 .NOP \f\*[B-Font]monlist\f[] [\f\*[I-Font]version\f[]] Obtain and print traffic counts collected and maintained by the monitor facility. The version number should not normally need to be specified.
7 .NOP \f\*[B-Font]clkbug\f[] \f\*[I-Font]clock_peer_address\f[] [\f\*[I-Font]...\f[]] Obtain debugging information for a reference clock driver. This information is provided only by some clock drivers and is mostly undecodable without a copy of the driver source in hand.
7 .NOP \f\*[B-Font]addpeer\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] Add a configured peer association at the given address and operating in symmetric active mode. Note that an existing association with the same peer may be deleted when this command is executed, or may simply be converted to conform to the new configuration, as appropriate. If the optional \f\*[I-Font]keyid\f[] is a nonzero integer, all outgoing packets to the remote server will have an authentication field attached encrypted with this key. If the value is 0 (or not given) no authentication will be done. The \f\*[I-Font]version\f[] can be 1, 2 or 3 and defaults to 3. The \f\*[B-Font]prefer\f[] keyword indicates a preferred peer (and thus will be used primarily for clock synchronisation if possible). The preferred peer also determines the validity of the PPS signal - if the preferred peer is suitable for synchronisation so is the PPS signal.
7 .NOP \f\*[B-Font]addserver\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] Identical to the addpeer command, except that the operating mode is client.
7 .NOP \f\*[B-Font]broadcast\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]keyid\f[]] [\f\*[I-Font]version\f[]] [\f\*[B-Font]prefer\f[]] Identical to the addpeer command, except that the operating mode is broadcast. In this case a valid key identifier and key are required. The \f\*[I-Font]peer_address\f[] parameter can be the broadcast address of the local network or a multicast group address assigned to NTP. If a multicast address, a multicast-capable kernel is required.
7 .NOP \f\*[B-Font]unconfig\f[] \f\*[I-Font]peer_address\f[] [\f\*[I-Font]...\f[]] This command causes the configured bit to be removed from the specified peer(s). In many cases this will cause the peer association to be deleted. When appropriate, however, the association may persist in an unconfigured mode if the remote peer is willing to continue on in this fashion.
7 .NOP \f\*[B-Font]fudge\f[] \f\*[I-Font]peer_address\f[] [\f\*[B-Font]time1\f[]] [\f\*[B-Font]time2\f[]] [\f\*[I-Font]stratum\f[]] [\f\*[I-Font]refid\f[]] This command provides a way to set certain data for a reference clock. See the source listing for further information.
7 .NOP \f\*[B-Font]enable\f[] [\f\*[B-Font]auth\f[] | \f\*[B-Font]bclient\f[] | \f\*[B-Font]calibrate\f[] | \f\*[B-Font]kernel\f[] | \f\*[B-Font]monitor\f[] | \f\*[B-Font]ntp\f[] | \f\*[B-Font]pps\f[] | \f\*[B-Font]stats\f[]]
7 .NOP \f\*[B-Font]disable\f[] [\f\*[B-Font]auth\f[] | \f\*[B-Font]bclient\f[] | \f\*[B-Font]calibrate\f[] | \f\*[B-Font]kernel\f[] | \f\*[B-Font]monitor\f[] | \f\*[B-Font]ntp\f[] | \f\*[B-Font]pps\f[] | \f\*[B-Font]stats\f[]] These commands operate in the same way as the \f\*[B-Font]enable\f[] and \f\*[B-Font]disable\f[] configuration file commands of ntpd\f[](1ntpdmdoc)\f[].
7 .NOP \f\*[B-Font]auth\f[] Enables the server to synchronize with unconfigured peers only if the peer has been correctly authenticated using either public key or private key cryptography. The default for this flag is enable.
7 .NOP \f\*[B-Font]bclient\f[] Enables the server to listen for a message from a broadcast or multicast server, as in the multicastclient command with default address. The default for this flag is disable.
7 .NOP \f\*[B-Font]calibrate\f[] Enables the calibrate feature for reference clocks. The default for this flag is disable.
7 .NOP \f\*[B-Font]kernel\f[] Enables the kernel time discipline, if available. The default for this flag is enable if support is available, otherwise disable.
7 .NOP \f\*[B-Font]monitor\f[] Enables the monitoring facility. See the documentation here about the \f\*[B-Font]monlist\f[] command or further information. The default for this flag is enable.
7 .NOP \f\*[B-Font]ntp\f[] Enables time and frequency discipline. In effect, this switch opens and closes the feedback loop, which is useful for testing. The default for this flag is enable.
7 .NOP \f\*[B-Font]pps\f[] Enables the pulse-per-second (PPS) signal when frequency and time is disciplined by the precision time kernel modifications. See the "A Kernel Model for Precision Timekeeping" (available as part of the HTML documentation provided in /usr/share/doc/ntp\f[]) page for further information. The default for this flag is disable.
7 .NOP \f\*[B-Font]stats\f[] Enables the statistics facility. See the Monitoring\f[] Options\f[] section of ntp.conf\f[](5)\f[] for further information. The default for this flag is disable.
7 .NOP \f\*[B-Font]restrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] \f\*[I-Font]flag\f[] [\f\*[I-Font]...\f[]] This command operates in the same way as the \f\*[B-Font]restrict\f[] configuration file commands of ntpd\f[](1ntpdmdoc)\f[].
7 .NOP \f\*[B-Font]unrestrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] \f\*[I-Font]flag\f[] [\f\*[I-Font]...\f[]] Unrestrict the matching entry from the restrict list.
7 .NOP \f\*[B-Font]delrestrict\f[] \f\*[I-Font]address\f[] \f\*[I-Font]mask\f[] [\f\*[B-Font]ntpport\f[]] Delete the matching entry from the restrict list.
7 .NOP \f\*[B-Font]readkeys\f[] Causes the current set of authentication keys to be purged and a new set to be obtained by rereading the keys file (which must have been specified in the ntpd\f[](1ntpdmdoc)\f[] configuration file). This allows encryption keys to be changed without restarting the server.
7 .NOP \f\*[B-Font]trustedkey\f[] \f\*[I-Font]keyid\f[] [\f\*[I-Font]...\f[]]
7 .NOP \f\*[B-Font]untrustedkey\f[] \f\*[I-Font]keyid\f[] [\f\*[I-Font]...\f[]] These commands operate in the same way as the \f\*[B-Font]trustedkey\f[] and \f\*[B-Font]untrustedkey\f[] configuration file commands of ntpd\f[](1ntpdmdoc)\f[].
7 .NOP \f\*[B-Font]authinfo\f[] Returns information concerning the authentication module, including known keys and counts of encryptions and decryptions which have been done.
7 .NOP \f\*[B-Font]traps\f[] Display the traps set in the server. See the source listing for further information.
7 .NOP \f\*[B-Font]addtrap\f[] \f\*[I-Font]address\f[] [\f\*[I-Font]port\f[]] [\f\*[I-Font]interface\f[]] Set a trap for asynchronous messages. See the source listing for further information.
7 .NOP \f\*[B-Font]clrtrap\f[] \f\*[I-Font]address\f[] [\f\*[I-Font]port\f[]] [\f\*[I-Font]interface\f[]] Clear a trap for asynchronous messages. See the source listing for further information.
7 .NOP \f\*[B-Font]reset\f[] Clear the statistics counters in various modules of the server. See the source listing for further information.
.NOP 0 " (EXIT_SUCCESS)" Successful program execution.
.NOP 1 " (EXIT_FAILURE)" The operation failed or the command syntax was not valid.
.NOP 66 " (EX_NOINPUT)" A specified configuration file could not be loaded.
.NOP 70 " (EX_SOFTWARE)" libopts had an internal operational error. Please report it to autogen-users@lists.sourceforge.net. Thank you.