contrib/ntp/ntpdc/ntpdc.1

   1 .TH NTPDC 1 2009-12-08 "( 4.2.4p8)" "Programmer's Manual"
   2 .\"  EDIT THIS FILE WITH CAUTION  (ntpdc.1)
   3 .\"
   4 .\"  It has been AutoGen-ed  Tuesday December  8, 2009 at 08:14:01 AM EST
   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 documents, briefly, 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 is a member of the ipv4 class of options.
  42 .sp
  43 Force DNS resolution of following host names on the command line
  44 to the IPv4 namespace.
  45 .TP
  46 .BR \-6 ", " \--ipv6
  47 Force IPv6 DNS name resolution.
  48 This option is a member of the ipv4 class of options.
  49 .sp
  50 Force DNS resolution of following host names on the command line
  51 to the IPv6 namespace.
  52 .TP
  53 .BR \-c " \fIcmd\fP, " \--command "=" \fIcmd\fP
  54 run a command and exit.
  55 This option may appear an unlimited number of times.
  56 .sp
  57 The following argument is interpreted as an interactive format command
  58 and is added to the list of commands to be executed on the specified
  59 host(s).
  60 .TP
  61 .BR \-l ", " \--listpeers
  62 Print a list of the peers.
  63 This option must not appear in combination with any of the following options:
  64 command.
  65 .sp
  66 Print a list of the peers known to the server as well as a summary of
  67 their state. This is equivalent to the 'listpeers' interactive command.
  68 .TP
  69 .BR \-p ", " \--peers
  70 Print a list of the peers.
  71 This option must not appear in combination with any of the following options:
  72 command.
  73 .sp
  74 Print a list of the peers known to the server as well as a summary
  75 of their state. This is equivalent to the 'peers' interactive command.
  76 .TP
  77 .BR \-s ", " \--showpeers
  78 Show a list of the peers.
  79 This option must not appear in combination with any of the following options:
  80 command.
  81 .sp
  82 Print a list of the peers known to the server as well as a summary
  83 of their state. This is equivalent to the 'dmpeers' interactive command.
  84 .TP
  85 .BR \-i ", " \--interactive
  86 Force ntpq to operate in interactive mode.
  87 This option must not appear in combination with any of the following options:
  88 command, listpeers, peers, showpeers.
  89 .sp
  90 Force ntpq to operate in interactive mode.  Prompts will be written
  91 to the standard output and commands read from the standard input.
  92 .TP
  93 .BR \-d ", " \--debug-level
  94 Increase output debug message level.
  95 This option may appear an unlimited number of times.
  96 .sp
  97 Increase the debugging message output level.
  98 .TP
  99 .BR \-D " \fIstring\fP, " \--set-debug-level "=" \fIstring\fP
 100 Set the output debug message level.
 101 This option may appear an unlimited number of times.
 102 .sp
 103 Set the output debugging level.  Can be supplied multiple times,
 104 but each overrides the previous value(s).
 105 .TP
 106 .BR \-n ", " \--numeric
 107 numeric host addresses.
 108 .sp
 109 Output all host addresses in dotted-quad numeric format rather than
 110 converting to the canonical host names.
 111 .TP
 112 .BR \-? , " \--help"
 113 Display usage information and exit.
 114 .TP
 115 .BR \-! , " \--more-help"
 116 Extended usage information passed thru pager.
 117 .TP
 118 .BR \-> " [\fIrcfile\fP]," " \--save-opts" "[=\fIrcfile\fP]"
 119 Save the option state to \fIrcfile\fP.  The default is the \fIlast\fP
 120 configuration file listed in the \fBOPTION PRESETS\fP section, below.
 121 .TP
 122 .BR \-< " \fIrcfile\fP," " \--load-opts" "=\fIrcfile\fP," " \--no-load-opts"
 123 Load options from \fIrcfile\fP.
 124 The \fIno-load-opts\fP form will disable the loading
 125 of earlier RC/INI files.  \fI--no-load-opts\fP is handled early,
 126 out of order.
 127 .TP
 128 .BR \-v " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
 129 Output version of program and exit.  The default mode is `v', a simple
 130 version.  The `c' mode will print copyright information and `n' will
 131 print the full copyright notice.
 132 .SH OPTION PRESETS
 133 Any option that is not marked as \fInot presettable\fP may be preset
 134 by loading values from configuration ("RC" or ".INI") file(s) and values from
 135 environment variables named:
 136 .nf
 137   \fBNTPDC_<option-name>\fP or \fBNTPDC\fP
 138 .fi
 139 .aj
 140 The environmental presets take precedence (are processed later than)
 141 the configuration files.
 142 The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
 143 If any of these are directories, then the file \fI.ntprc\fP
 144 is searched for within those directories.
 145 .SH AUTHOR
 146 David L. Mills and/or others
 147 .br
 148 Please send bug reports to:  http://bugs.ntp.org, bugs@ntp.org
 149
 150 .PP
 151 .nf
 152 .na
 153 see html/copyright.html
 154 .fi
 155 .ad
 156 .PP
 157 This manual page was \fIAutoGen\fP-erated from the \fBntpdc\fP
 158 option definitions.