/contrib/ntp/sntp/sntp-opts.texi

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 225 lines · 182 code · 43 blank · 0 comment · 0 complexity · fca8c14a84a5de8a63860448eb50d608 MD5 · raw file

  1. @node sntp Invocation
  2. @section Invoking sntp
  3. @pindex sntp
  4. @cindex standard SNTP program
  5. @ignore
  6. #
  7. # EDIT THIS FILE WITH CAUTION (sntp-opts.texi)
  8. #
  9. # It has been AutoGen-ed Tuesday December 8, 2009 at 08:14:51 AM EST
  10. # From the definitions sntp-opts.def
  11. # and the template file aginfo.tpl
  12. @end ignore
  13. This program has no explanation.
  14. .I sntp
  15. can be used as a SNTP client to query a NTP or SNTP server and either display
  16. the time or set the local system's time (given suitable privilege). It can be
  17. run as an interactive command or in a
  18. .I cron
  19. job.
  20. NTP is the Network Time Protocol (RFC 1305) and SNTP is the
  21. Simple Network Time Protocol (RFC 2030, which supersedes RFC 1769).
  22. This section was generated by @strong{AutoGen},
  23. the aginfo template and the option descriptions for the @command{sntp} program. It documents the sntp usage text and option meanings.
  24. This software is released under a specialized copyright license.
  25. @menu
  26. * sntp usage:: sntp usage help (-?)
  27. * sntp adjtime:: adjtime option (-a)
  28. * sntp extraverbose:: extraverbose option (-V)
  29. * sntp ipv4:: ipv4 option (-4)
  30. * sntp ipv6:: ipv6 option (-6)
  31. * sntp megaverbose:: megaverbose option (-W)
  32. * sntp normalverbose:: normalverbose option (-v)
  33. * sntp settimeofday:: settimeofday option (-r)
  34. * sntp unprivport:: unprivport option (-u)
  35. @end menu
  36. @node sntp usage
  37. @subsection sntp usage help (-?)
  38. @cindex sntp usage
  39. This is the automatically generated usage text for sntp:
  40. @exampleindent 0
  41. @example
  42. sntp - standard SNTP program - Ver. 4.2.5p247-RC
  43. USAGE: sntp [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... ...
  44. Flg Arg Option-Name Description
  45. -4 no ipv4 Force IPv4 DNS name resolution
  46. - prohibits these options:
  47. ipv6
  48. -6 no ipv6 Force IPv6 DNS name resolution
  49. - prohibits these options:
  50. ipv4
  51. -d no normalverbose Normal verbose
  52. -K Str kod KoD history filename
  53. -p no syslog Logging with syslog
  54. - prohibits these options:
  55. filelog
  56. -l Str filelog Logging to specified logfile
  57. - prohibits these options:
  58. syslog
  59. -s no settod Set (step) the time with settimeofday()
  60. - prohibits these options:
  61. adjtime
  62. -j no adjtime Set (slew) the time with adjtime()
  63. - prohibits these options:
  64. settod
  65. -b Str broadcast Use broadcasts to the address specified for synchronisation
  66. -t Num timeout Specify the number of seconds to wait for broadcasts
  67. -a Num authentication Enable authentication with the key keyno. This option is used as -a keyno
  68. -k Str keyfile Specify a keyfile. SNTP will look in this file for the key specified with -a
  69. opt version Output version information and exit
  70. -? no help Display extended usage information and exit
  71. -! no more-help Extended usage information passed thru pager
  72. -> opt save-opts Save the option state to a config file
  73. -< Str load-opts Load options from a config file
  74. - disabled as --no-load-opts
  75. - may appear multiple times
  76. Options are specified by doubled hyphens and their name
  77. or by a single hyphen and the flag character.
  78. The following option preset mechanisms are supported:
  79. - reading file /users/stenn/.ntprc
  80. - reading file /deacon/backroom/snaps/ntp-stable/sntp/.ntprc
  81. - examining environment variables named SNTP_*
  82. .I sntp
  83. can be used as a SNTP client to query a NTP or SNTP server and either display
  84. the time or set the local system's time (given suitable privilege). It can be
  85. run as an interactive command or in a
  86. .I cron
  87. job.
  88. NTP is the Network Time Protocol (RFC 1305) and SNTP is the
  89. Simple Network Time Protocol (RFC 2030, which supersedes RFC 1769).
  90. please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org
  91. @end example
  92. @exampleindent 4
  93. @node sntp ipv4
  94. @subsection ipv4 option (-4)
  95. @cindex sntp-ipv4
  96. This is the ``force ipv4 dns name resolution'' option.
  97. This option has some usage constraints. It:
  98. @itemize @bullet
  99. @item
  100. is a member of the ipv4 class of options.
  101. @end itemize
  102. Force DNS resolution of following host names on the command line
  103. to the IPv4 namespace.
  104. @node sntp ipv6
  105. @subsection ipv6 option (-6)
  106. @cindex sntp-ipv6
  107. This is the ``force ipv6 dns name resolution'' option.
  108. This option has some usage constraints. It:
  109. @itemize @bullet
  110. @item
  111. is a member of the ipv4 class of options.
  112. @end itemize
  113. Force DNS resolution of following host names on the command line
  114. to the IPv6 namespace.
  115. @node sntp unprivport
  116. @subsection unprivport option (-u)
  117. @cindex sntp-unprivport
  118. This is the ``use an unprivileged port'' option.
  119. Use an unprivilegded UDP port for our queries.
  120. @node sntp normalverbose
  121. @subsection normalverbose option (-v)
  122. @cindex sntp-normalverbose
  123. This is the ``slightly verbose'' option.
  124. This option has some usage constraints. It:
  125. @itemize @bullet
  126. @item
  127. must not appear in combination with any of the following options:
  128. extraverbose, megaverbose.
  129. @end itemize
  130. Diagnostic messages for non-fatal errors and a limited amount of
  131. tracing should be written to standard error. Fatal ones always
  132. produce a diagnostic. This option should be set when there is a
  133. suspected problem with the server, network or the source.
  134. @node sntp extraverbose
  135. @subsection extraverbose option (-V)
  136. @cindex sntp-extraverbose
  137. This is the ``extra verbose'' option.
  138. This option has some usage constraints. It:
  139. @itemize @bullet
  140. @item
  141. must not appear in combination with any of the following options:
  142. normalverbose, megaverbose.
  143. @end itemize
  144. Produce more and less comprehensible output, mainly for investigating
  145. problems with apparently inconsistent timestamps. This option should
  146. be set when the program fails with a message indicating that is the
  147. trouble.
  148. @node sntp megaverbose
  149. @subsection megaverbose option (-W)
  150. @cindex sntp-megaverbose
  151. This is the ``mega verbose'' option.
  152. This option has some usage constraints. It:
  153. @itemize @bullet
  154. @item
  155. must not appear in combination with any of the following options:
  156. normalverbose, extraverbose.
  157. @end itemize
  158. Very verbose debugging output that will interfere with the timing
  159. when writing to the terminal (because of line buffered output from C).
  160. Note that the times produced by this are the corrections needed, and
  161. not the error in the local clock. This option should be set only when
  162. debugging the source.
  163. @node sntp settimeofday
  164. @subsection settimeofday option (-r)
  165. @cindex sntp-settimeofday
  166. This is the ``set (step) the time with settimeofday()'' option.
  167. This option has some usage constraints. It:
  168. @itemize @bullet
  169. @item
  170. must not appear in combination with any of the following options:
  171. adjtime.
  172. @end itemize
  173. @node sntp adjtime
  174. @subsection adjtime option (-a)
  175. @cindex sntp-adjtime
  176. This is the ``set (slew) the time with adjtime()'' 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. settimeofday.
  182. @end itemize