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  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
  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 - standard SNTP program - Ver. 4.2.5p247-RC
  50 USAGE:  sntp [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... ...
  51   Flg Arg Option-Name    Description
  52    -4 no  ipv4           Force IPv4 DNS name resolution
  53                                 - prohibits these options:
  54                                 ipv6
  55    -6 no  ipv6           Force IPv6 DNS name resolution
  56                                 - prohibits these options:
  57                                 ipv4
  58    -d no  normalverbose  Normal verbose
  59    -K Str kod            KoD history filename
  60    -p no  syslog         Logging with syslog
  61                                 - prohibits these options:
  62                                 filelog
  63    -l Str filelog        Logging to specified logfile
  64                                 - prohibits these options:
  65                                 syslog
  66    -s no  settod         Set (step) the time with settimeofday()
  67                                 - prohibits these options:
  68                                 adjtime
  69    -j no  adjtime        Set (slew) the time with adjtime()
  70                                 - prohibits these options:
  71                                 settod
  72    -b Str broadcast      Use broadcasts to the address specified for synchronisation
  73    -t Num timeout        Specify the number of seconds to wait for broadcasts
  74    -a Num authentication Enable authentication with the key keyno. This option is used as -a keyno
  75    -k Str keyfile        Specify a keyfile. SNTP will look in this file for the key specified with -a
  76       opt version        Output version information and exit
  77    -? no  help           Display extended usage information and exit
  78    -! no  more-help      Extended usage information passed thru pager
  79    -> opt save-opts      Save the option state to a config file
  80    -< Str load-opts      Load options from a config file
  81                                 - disabled as --no-load-opts
  82                                 - may appear multiple times
  83
  84 Options are specified by doubled hyphens and their name
  85 or by a single hyphen and the flag character.
  86
  87 The following option preset mechanisms are supported:
  88  - reading file /users/stenn/.ntprc
  89  - reading file /deacon/backroom/snaps/ntp-stable/sntp/.ntprc
  90  - examining environment variables named SNTP_*
  91
  92 .I sntp
  93 can be used as a SNTP client to query a NTP or SNTP server and either display
  94 the time or set the local system's time (given suitable privilege).  It can be
  95 run as an interactive command or in a
  96 .I cron
  97 job.
  98 NTP is the Network Time Protocol (RFC 1305) and SNTP is the
  99 Simple Network Time Protocol (RFC 2030, which supersedes RFC 1769).
 100
 101 please send bug reports to:  http://bugs.ntp.org, bugs@@ntp.org
 102 @end example
 103 @exampleindent 4
 104
 105 @node sntp ipv4
 106 @subsection ipv4 option (-4)
 107 @cindex sntp-ipv4
 108
 109 This is the ``force ipv4 dns name resolution'' option.
 110
 111 This option has some usage constraints.  It:
 112 @itemize @bullet
 113 @item
 114 is a member of the ipv4 class of options.
 115 @end itemize
 116
 117 Force DNS resolution of following host names on the command line
 118 to the IPv4 namespace.
 119
 120 @node sntp ipv6
 121 @subsection ipv6 option (-6)
 122 @cindex sntp-ipv6
 123
 124 This is the ``force ipv6 dns name resolution'' option.
 125
 126 This option has some usage constraints.  It:
 127 @itemize @bullet
 128 @item
 129 is a member of the ipv4 class of options.
 130 @end itemize
 131
 132 Force DNS resolution of following host names on the command line
 133 to the IPv6 namespace.
 134
 135 @node sntp unprivport
 136 @subsection unprivport option (-u)
 137 @cindex sntp-unprivport
 138
 139 This is the ``use an unprivileged port'' option.
 140 Use an unprivilegded UDP port for our queries.
 141
 142 @node sntp normalverbose
 143 @subsection normalverbose option (-v)
 144 @cindex sntp-normalverbose
 145
 146 This is the ``slightly verbose'' option.
 147
 148 This option has some usage constraints.  It:
 149 @itemize @bullet
 150 @item
 151 must not appear in combination with any of the following options:
 152 extraverbose, megaverbose.
 153 @end itemize
 154
 155 Diagnostic messages for non-fatal errors and a limited amount of
 156 tracing should be written to standard error.  Fatal ones always
 157 produce a diagnostic.  This option should be set when there is a
 158 suspected problem with the server, network or the source.
 159
 160 @node sntp extraverbose
 161 @subsection extraverbose option (-V)
 162 @cindex sntp-extraverbose
 163
 164 This is the ``extra verbose'' 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 normalverbose, megaverbose.
 171 @end itemize
 172
 173 Produce more and less comprehensible output, mainly for investigating
 174 problems with apparently inconsistent timestamps.  This option should
 175 be set when the program fails with a message indicating that is the
 176 trouble.
 177
 178 @node sntp megaverbose
 179 @subsection megaverbose option (-W)
 180 @cindex sntp-megaverbose
 181
 182 This is the ``mega verbose'' option.
 183
 184 This option has some usage constraints.  It:
 185 @itemize @bullet
 186 @item
 187 must not appear in combination with any of the following options:
 188 normalverbose, extraverbose.
 189 @end itemize
 190
 191 Very verbose debugging output that will interfere with the timing
 192 when writing to the terminal (because of line buffered output from C).
 193 Note that the times produced by this are the corrections needed, and
 194 not the error in the local clock.  This option should be set only when
 195 debugging the source.
 196
 197 @node sntp settimeofday
 198 @subsection settimeofday option (-r)
 199 @cindex sntp-settimeofday
 200
 201 This is the ``set (step) the time with settimeofday()'' option.
 202
 203 This option has some usage constraints.  It:
 204 @itemize @bullet
 205 @item
 206 must not appear in combination with any of the following options:
 207 adjtime.
 208 @end itemize
 209
 210
 211
 212 @node sntp adjtime
 213 @subsection adjtime option (-a)
 214 @cindex sntp-adjtime
 215
 216 This is the ``set (slew) the time with adjtime()'' option.
 217
 218 This option has some usage constraints.  It:
 219 @itemize @bullet
 220 @item
 221 must not appear in combination with any of the following options:
 222 settimeofday.
 223 @end itemize
 224
 225