/contrib/ntp/ntpdc/ntpdc-opts.texi
Unknown | 278 lines | 227 code | 51 blank | 0 comment | 0 complexity | 3ff5a428bdc0086756e687cb1f6be12d MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, BSD-3-Clause, LGPL-2.0, LGPL-2.1, BSD-2-Clause, 0BSD, JSON, AGPL-1.0, GPL-2.0
1@node ntpdc Invocation 2@section Invoking ntpdc 3@pindex ntpdc 4@cindex vendor-specific NTP query program 5@ignore 6# 7# EDIT THIS FILE WITH CAUTION (ntpdc-opts.texi) 8# 9# It has been AutoGen-ed Tuesday December 8, 2009 at 08:14:02 AM EST 10# From the definitions ntpdc-opts.def 11# and the template file aginfo.tpl 12@end ignore 13This program has no explanation. 14 15The 16[= prog-name =] 17utility program is used to query an NTP daemon about its 18current state and to request changes in that state. 19It uses NTP mode 7 control message formats described in the source code. 20The program may 21be run either in interactive mode or controlled using command line 22arguments. 23Extensive state and statistics information is available 24through the 25[= prog-name =] 26interface. 27In addition, nearly all the 28configuration options which can be specified at startup using 29ntpd's configuration file may also be specified at run time using 30[= prog-name =] . 31 32 33 34This section was generated by @strong{AutoGen}, 35the aginfo template and the option descriptions for the @command{ntpdc} program. It documents the ntpdc usage text and option meanings. 36 37This software is released under a specialized copyright license. 38 39@menu 40* ntpdc usage:: ntpdc usage help (-?) 41* ntpdc command:: command option (-c) 42* ntpdc debug-level:: debug-level option (-d) 43* ntpdc interactive:: interactive option (-i) 44* ntpdc ipv4:: ipv4 option (-4) 45* ntpdc ipv6:: ipv6 option (-6) 46* ntpdc listpeers:: listpeers option (-l) 47* ntpdc numeric:: numeric option (-n) 48* ntpdc peers:: peers option (-p) 49* ntpdc set-debug-level:: set-debug-level option (-D) 50* ntpdc showpeers:: showpeers option (-s) 51@end menu 52 53@node ntpdc usage 54@subsection ntpdc usage help (-?) 55@cindex ntpdc usage 56 57This is the automatically generated usage text for ntpdc: 58 59@exampleindent 0 60@example 61ntpdc - vendor-specific NTP query program - Ver. 4.2.5p247-RC 62USAGE: ntpdc [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...] 63 Flg Arg Option-Name Description 64 -4 no ipv4 Force IPv4 DNS name resolution 65 - prohibits these options: 66 ipv6 67 -6 no ipv6 Force IPv6 DNS name resolution 68 - prohibits these options: 69 ipv4 70 -c Str command run a command and exit 71 - may appear multiple times 72 -l no listpeers Print a list of the peers 73 - prohibits these options: 74 command 75 -p no peers Print a list of the peers 76 - prohibits these options: 77 command 78 -s no showpeers Show a list of the peers 79 - prohibits these options: 80 command 81 -i no interactive Force ntpq to operate in interactive mode 82 - prohibits these options: 83 command 84 listpeers 85 peers 86 showpeers 87 -d no debug-level Increase output debug message level 88 - may appear multiple times 89 -D Str set-debug-level Set the output debug message level 90 - may appear multiple times 91 -n no numeric numeric host addresses 92 opt version Output version information and exit 93 -? no help Display extended usage information and exit 94 -! no more-help Extended usage information passed thru pager 95 -> opt save-opts Save the option state to a config file 96 -< Str load-opts Load options from a config file 97 - disabled as --no-load-opts 98 - may appear multiple times 99 100Options are specified by doubled hyphens and their name 101or by a single hyphen and the flag character. 102 103The following option preset mechanisms are supported: 104 - reading file /users/stenn/.ntprc 105 - reading file /deacon/backroom/snaps/ntp-stable/ntpdc/.ntprc 106 - examining environment variables named NTPDC_* 107 108The 109[= prog-name =] 110utility program is used to query an NTP daemon about its 111current state and to request changes in that state. 112It uses NTP mode 7 control message formats described in the source code. 113The program may 114be run either in interactive mode or controlled using command line 115arguments. 116Extensive state and statistics information is available 117through the 118[= prog-name =] 119interface. 120In addition, nearly all the 121configuration options which can be specified at startup using 122ntpd's configuration file may also be specified at run time using 123[= prog-name =] . 124 125please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org 126@end example 127@exampleindent 4 128 129@node ntpdc ipv4 130@subsection ipv4 option (-4) 131@cindex ntpdc-ipv4 132 133This is the ``force ipv4 dns name resolution'' option. 134 135This option has some usage constraints. It: 136@itemize @bullet 137@item 138is a member of the ipv4 class of options. 139@end itemize 140 141Force DNS resolution of following host names on the command line 142to the IPv4 namespace. 143 144@node ntpdc ipv6 145@subsection ipv6 option (-6) 146@cindex ntpdc-ipv6 147 148This is the ``force ipv6 dns name resolution'' option. 149 150This option has some usage constraints. It: 151@itemize @bullet 152@item 153is a member of the ipv4 class of options. 154@end itemize 155 156Force DNS resolution of following host names on the command line 157to the IPv6 namespace. 158 159@node ntpdc command 160@subsection command option (-c) 161@cindex ntpdc-command 162 163This is the ``run a command and exit'' option. 164 165This option has some usage constraints. It: 166@itemize @bullet 167@item 168may appear an unlimited number of times. 169@end itemize 170 171The following argument is interpreted as an interactive format command 172and is added to the list of commands to be executed on the specified 173host(s). 174 175@node ntpdc listpeers 176@subsection listpeers option (-l) 177@cindex ntpdc-listpeers 178 179This is the ``print a list of the peers'' option. 180 181This option has some usage constraints. It: 182@itemize @bullet 183@item 184must not appear in combination with any of the following options: 185command. 186@end itemize 187 188Print a list of the peers known to the server as well as a summary of 189their state. This is equivalent to the 'listpeers' interactive command. 190 191@node ntpdc peers 192@subsection peers option (-p) 193@cindex ntpdc-peers 194 195This is the ``print a list of the peers'' option. 196 197This option has some usage constraints. It: 198@itemize @bullet 199@item 200must not appear in combination with any of the following options: 201command. 202@end itemize 203 204Print a list of the peers known to the server as well as a summary 205of their state. This is equivalent to the 'peers' interactive command. 206 207@node ntpdc showpeers 208@subsection showpeers option (-s) 209@cindex ntpdc-showpeers 210 211This is the ``show a list of the peers'' option. 212 213This option has some usage constraints. It: 214@itemize @bullet 215@item 216must not appear in combination with any of the following options: 217command. 218@end itemize 219 220Print a list of the peers known to the server as well as a summary 221of their state. This is equivalent to the 'dmpeers' interactive command. 222 223@node ntpdc interactive 224@subsection interactive option (-i) 225@cindex ntpdc-interactive 226 227This is the ``force ntpq to operate in interactive mode'' option. 228 229This option has some usage constraints. It: 230@itemize @bullet 231@item 232must not appear in combination with any of the following options: 233command, listpeers, peers, showpeers. 234@end itemize 235 236Force ntpq to operate in interactive mode. Prompts will be written 237to the standard output and commands read from the standard input. 238 239@node ntpdc debug-level 240@subsection debug-level option (-d) 241@cindex ntpdc-debug-level 242 243This is the ``increase output debug message level'' option. 244 245This option has some usage constraints. It: 246@itemize @bullet 247@item 248may appear an unlimited number of times. 249@item 250must be compiled in by defining @code{DEBUG} during the compilation. 251@end itemize 252 253Increase the debugging message output level. 254 255@node ntpdc set-debug-level 256@subsection set-debug-level option (-D) 257@cindex ntpdc-set-debug-level 258 259This is the ``set the output debug message level'' option. 260 261This option has some usage constraints. It: 262@itemize @bullet 263@item 264may appear an unlimited number of times. 265@item 266must be compiled in by defining @code{DEBUG} during the compilation. 267@end itemize 268 269Set the output debugging level. Can be supplied multiple times, 270but each overrides the previous value(s). 271 272@node ntpdc numeric 273@subsection numeric option (-n) 274@cindex ntpdc-numeric 275 276This is the ``numeric host addresses'' option. 277Output all host addresses in dotted-quad numeric format rather than 278converting to the canonical host names.