contrib/ntp/sntp/sntp-opts.texi

   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  Sunday August 17, 2008 at 05:27:25 AM EDT
  10 # From the definitions    sntp-opts.def
  11 # and the template file   aginfo.tpl
  12 @end ignore
  13 This program has no explanation.
  14
  15 .I sntp
  16 can be used as a SNTP client to query a NTP or SNTP server and either display
  17 the time or set the local system's time (given suitable privilege).  It can be
  18 run as an interactive command or in a
  19 .I cron
  20 job.
  21 NTP is the Network Time Protocol (RFC 1305) and SNTP is the
  22 Simple Network Time Protocol (RFC 2030, which supersedes RFC 1769).
  23
  24 This section was generated by @strong{AutoGen},
  25 the aginfo template and the option descriptions for the @command{sntp} program.  It documents the sntp usage text and option meanings.
  26
  27 This software is released under a specialized copyright license.
  28
  29 @menu
  30 * sntp usage::                  sntp usage help (-?)
  31 * sntp adjtime::                adjtime option (-a)
  32 * sntp extraverbose::           extraverbose option (-V)
  33 * sntp ipv4::                   ipv4 option (-4)
  34 * sntp ipv6::                   ipv6 option (-6)
  35 * sntp megaverbose::            megaverbose option (-W)
  36 * sntp normalverbose::          normalverbose option (-v)
  37 * sntp settimeofday::           settimeofday option (-r)
  38 * sntp unprivport::             unprivport option (-u)
  39 @end menu
  40
  41 @node sntp usage
  42 @subsection sntp usage help (-?)
  43 @cindex sntp usage
  44
  45 This is the automatically generated usage text for sntp:
  46
  47 @exampleindent 0
  48 @example
  49 sntp is unavailable - no --help
  50 @end example
  51 @exampleindent 4
  52
  53 @node sntp ipv4
  54 @subsection ipv4 option (-4)
  55 @cindex sntp-ipv4
  56
  57 This is the ``force ipv4 dns name resolution'' option.
  58
  59 This option has some usage constraints.  It:
  60 @itemize @bullet
  61 @item
  62 is a member of the ipv4 class of options.
  63 @end itemize
  64
  65 Force DNS resolution of following host names on the command line
  66 to the IPv4 namespace.
  67
  68 @node sntp ipv6
  69 @subsection ipv6 option (-6)
  70 @cindex sntp-ipv6
  71
  72 This is the ``force ipv6 dns name resolution'' option.
  73
  74 This option has some usage constraints.  It:
  75 @itemize @bullet
  76 @item
  77 is a member of the ipv4 class of options.
  78 @end itemize
  79
  80 Force DNS resolution of following host names on the command line
  81 to the IPv6 namespace.
  82
  83 @node sntp unprivport
  84 @subsection unprivport option (-u)
  85 @cindex sntp-unprivport
  86
  87 This is the ``use an unprivileged port'' option.
  88 Use an unprivilegded UDP port for our queries.
  89
  90 @node sntp normalverbose
  91 @subsection normalverbose option (-v)
  92 @cindex sntp-normalverbose
  93
  94 This is the ``slightly verbose'' option.
  95
  96 This option has some usage constraints.  It:
  97 @itemize @bullet
  98 @item
  99 must not appear in combination with any of the following options:
 100 extraverbose, megaverbose.
 101 @end itemize
 102
 103 Diagnostic messages for non-fatal errors and a limited amount of
 104 tracing should be written to standard error.  Fatal ones always
 105 produce a diagnostic.  This option should be set when there is a
 106 suspected problem with the server, network or the source.
 107
 108 @node sntp extraverbose
 109 @subsection extraverbose option (-V)
 110 @cindex sntp-extraverbose
 111
 112 This is the ``extra verbose'' option.
 113
 114 This option has some usage constraints.  It:
 115 @itemize @bullet
 116 @item
 117 must not appear in combination with any of the following options:
 118 normalverbose, megaverbose.
 119 @end itemize
 120
 121 Produce more and less comprehensible output, mainly for investigating
 122 problems with apparently inconsistent timestamps.  This option should
 123 be set when the program fails with a message indicating that is the
 124 trouble.
 125
 126 @node sntp megaverbose
 127 @subsection megaverbose option (-W)
 128 @cindex sntp-megaverbose
 129
 130 This is the ``mega verbose'' option.
 131
 132 This option has some usage constraints.  It:
 133 @itemize @bullet
 134 @item
 135 must not appear in combination with any of the following options:
 136 normalverbose, extraverbose.
 137 @end itemize
 138
 139 Very verbose debugging output that will interfere with the timing
 140 when writing to the terminal (because of line buffered output from C).
 141 Note that the times produced by this are the corrections needed, and
 142 not the error in the local clock.  This option should be set only when
 143 debugging the source.
 144
 145 @node sntp settimeofday
 146 @subsection settimeofday option (-r)
 147 @cindex sntp-settimeofday
 148
 149 This is the ``set (step) the time with settimeofday()'' option.
 150
 151 This option has some usage constraints.  It:
 152 @itemize @bullet
 153 @item
 154 must not appear in combination with any of the following options:
 155 adjtime.
 156 @end itemize
 157
 158
 159
 160 @node sntp adjtime
 161 @subsection adjtime option (-a)
 162 @cindex sntp-adjtime
 163
 164 This is the ``set (slew) the time with adjtime()'' option.
 165
 166 This option has some usage constraints.  It:
 167 @itemize @bullet
 168 @item
 169 must not appear in combination with any of the following options:
 170 settimeofday.
 171 @end itemize
 172
 173