/contrib/ntp/ntpdc/ntpdc-opts.texi

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 278 lines · 227 code · 51 blank · 0 comment · 0 complexity · 3ff5a428bdc0086756e687cb1f6be12d MD5 · raw file

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