external/bsd/ntp/dist/ntpdc/ntpdc.1

   1 .TH NTPDC 1 2009-12-10 "( 4.2.6)" "Programmer's Manual"
   2 .\"  EDIT THIS FILE WITH CAUTION  (ntpdc.1)
   3 .\"
   4 .\"  It has been AutoGen-ed  December 10, 2009 at 05:02:37 AM by AutoGen 5.10
   5 .\"  From the definitions    ntpdc-opts.def
   6 .\"  and the template file   agman1.tpl
   7 .\"
   8 .SH NAME
   9 ntpdc \- vendor-specific NTP query program
  10 .SH SYNOPSIS
  11 .B ntpdc
  12 .\" Mixture of short (flag) options and long options
  13 .RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \--\fIopt-name\fP " [[=| ]\fIvalue\fP]]..."
  14 .br
  15 .in +8
  16 [ host ...]
  17 .SH "DESCRIPTION"
  18 This manual page briefly documents the \fBntpdc\fP command.
  19 The
  20 [= prog-name =]
  21 utility program is used to query an NTP daemon about its
  22 current state and to request changes in that state.
  23 It uses NTP mode 7 control message formats described in the source code.
  24 The program may
  25 be run either in interactive mode or controlled using command line
  26 arguments.
  27 Extensive state and statistics information is available
  28 through the
  29 [= prog-name =]
  30 interface.
  31 In addition, nearly all the
  32 configuration options which can be specified at startup using
  33 ntpd's configuration file may also be specified at run time using
  34 [= prog-name =] .
  35
  36
  37 .SH OPTIONS
  38 .TP
  39 .BR \-4 ", " \--ipv4
  40 Force IPv4 DNS name resolution.
  41 This option must not appear in combination with any of the following options:
  42 ipv6.
  43 .sp
  44 Force DNS resolution of following host names on the command line
  45 to the IPv4 namespace.
  46 .TP
  47 .BR \-6 ", " \--ipv6
  48 Force IPv6 DNS name resolution.
  49 This option must not appear in combination with any of the following options:
  50 ipv4.
  51 .sp
  52 Force DNS resolution of following host names on the command line
  53 to the IPv6 namespace.
  54 .TP
  55 .BR \-c " \fIcmd\fP, " \--command "=" \fIcmd\fP
  56 run a command and exit.
  57 This option may appear an unlimited number of times.
  58 .sp
  59 The following argument is interpreted as an interactive format command
  60 and is added to the list of commands to be executed on the specified
  61 host(s).
  62 .TP
  63 .BR \-l ", " \--listpeers
  64 Print a list of the peers.
  65 This option must not appear in combination with any of the following options:
  66 command.
  67 .sp
  68 Print a list of the peers known to the server as well as a summary of
  69 their state. This is equivalent to the 'listpeers' interactive command.
  70 .TP
  71 .BR \-p ", " \--peers
  72 Print a list of the peers.
  73 This option must not appear in combination with any of the following options:
  74 command.
  75 .sp
  76 Print a list of the peers known to the server as well as a summary
  77 of their state. This is equivalent to the 'peers' interactive command.
  78 .TP
  79 .BR \-s ", " \--showpeers
  80 Show a list of the peers.
  81 This option must not appear in combination with any of the following options:
  82 command.
  83 .sp
  84 Print a list of the peers known to the server as well as a summary
  85 of their state. This is equivalent to the 'dmpeers' interactive command.
  86 .TP
  87 .BR \-i ", " \--interactive
  88 Force ntpq to operate in interactive mode.
  89 This option must not appear in combination with any of the following options:
  90 command, listpeers, peers, showpeers.
  91 .sp
  92 Force ntpq to operate in interactive mode.  Prompts will be written
  93 to the standard output and commands read from the standard input.
  94 .TP
  95 .BR \-d ", " \--debug-level
  96 Increase output debug message level.
  97 This option may appear an unlimited number of times.
  98 .sp
  99 Increase the debugging message output level.
 100 .TP
 101 .BR \-D " \fIstring\fP, " \--set-debug-level "=" \fIstring\fP
 102 Set the output debug message level.
 103 This option may appear an unlimited number of times.
 104 .sp
 105 Set the output debugging level.  Can be supplied multiple times,
 106 but each overrides the previous value(s).
 107 .TP
 108 .BR \-n ", " \--numeric
 109 numeric host addresses.
 110 .sp
 111 Output all host addresses in dotted-quad numeric format rather than
 112 converting to the canonical host names.
 113 .TP
 114 .BR \-? , " \--help"
 115 Display extended usage information and exit.
 116 .TP
 117 .BR \-! , " \--more-help"
 118 Extended usage information passed thru pager.
 119 .TP
 120 .BR \-> " [\fIrcfile\fP]," " \--save-opts" "[=\fIrcfile\fP]"
 121 Save the option state to \fIrcfile\fP.  The default is the \fIlast\fP
 122 configuration file listed in the \fBOPTION PRESETS\fP section, below.
 123 .TP
 124 .BR \-< " \fIrcfile\fP," " \--load-opts" "=\fIrcfile\fP," " \--no-load-opts"
 125 Load options from \fIrcfile\fP.
 126 The \fIno-load-opts\fP form will disable the loading
 127 of earlier RC/INI files.  \fI--no-load-opts\fP is handled early,
 128 out of order.
 129 .TP
 130 .BR \- " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
 131 Output version of program and exit.  The default mode is `v', a simple
 132 version.  The `c' mode will print copyright information and `n' will
 133 print the full copyright notice.
 134 .SH OPTION PRESETS
 135 Any option that is not marked as \fInot presettable\fP may be preset
 136 by loading values from configuration ("RC" or ".INI") file(s) and values from
 137 environment variables named:
 138 .nf
 139   \fBNTPDC_<option-name>\fP or \fBNTPDC\fP
 140 .fi
 141 .ad
 142 The environmental presets take precedence (are processed later than)
 143 the configuration files.
 144 The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
 145 If any of these are directories, then the file \fI.ntprc\fP
 146 is searched for within those directories.
 147 .SH AUTHOR
 148 David L. Mills and/or others
 149 .br
 150 Please send bug reports to:  http://bugs.ntp.org, bugs@ntp.org
 151
 152 .PP
 153 .nf
 154 .na
 155 see html/copyright.html
 156 .fi
 157 .ad
 158 .PP
 159 This manual page was \fIAutoGen\fP-erated from the \fBntpdc\fP
 160 option definitions.