Annotation of embedaddon/ntp/sntp/sntp-opts.texi, revision 1.1
1.1 ! misho 1: @node sntp Invocation
! 2: @section Invoking sntp
! 3: @pindex sntp
! 4: @cindex standard Simple Network Time Protocol program
! 5: @ignore
! 6: #
! 7: # EDIT THIS FILE WITH CAUTION (sntp-opts.texi)
! 8: #
! 9: # It has been AutoGen-ed December 24, 2011 at 06:34:00 PM by AutoGen 5.12
! 10: # From the definitions sntp-opts.def
! 11: # and the template file aginfo.tpl
! 12: @end ignore
! 13:
! 14: @code{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: @code{cron}
! 19: job.
! 20:
! 21: NTP (the Network Time Protocol) and SNTP (the Simple Network Time Protocol)
! 22: are defined and described by RFC 5905.
! 23:
! 24: @indent
! 25: The default is to write the estimated correct local date and time (i.e. not
! 26: UTC) to the standard output in a format like
! 27: @example
! 28: 1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
! 29: @end example
! 30: where the
! 31: @example
! 32: +4.567 +/- 0.089 secs
! 33: @end example
! 34: indicates the local clock is 4.567 seconds behind the correct time
! 35: (so 4.567 seconds must be added to the local clock to get it to be correct),
! 36: and the (local) time of
! 37: @code{1996-10-15 20:17:25.123}
! 38: can be converted to UTC time by adding 8 hours and 0 minutes, and
! 39: is believed to be correct to within
! 40: @code{+/- 0.089}
! 41: seconds.
! 42:
! 43: This section was generated by @strong{AutoGen},
! 44: the aginfo template and the option descriptions for the @command{sntp} program. It documents the @command{sntp} usage text and option meanings.
! 45:
! 46: This software is released under a specialized copyright license.
! 47:
! 48: @menu
! 49: * sntp usage:: sntp usage help (-?)
! 50: * sntp adjtime:: adjtime option (-j)
! 51: * sntp authentication:: authentication option (-a)
! 52: * sntp broadcast:: broadcast option (-b)
! 53: * sntp ipv4:: ipv4 option (-4)
! 54: * sntp ipv6:: ipv6 option (-6)
! 55: * sntp keyfile:: keyfile option (-k)
! 56: * sntp kod:: kod option (-K)
! 57: * sntp logfile:: logfile option (-l)
! 58: * sntp normalverbose:: normalverbose option (-d)
! 59: * sntp settod:: settod option (-s)
! 60: * sntp syslog:: syslog option (-p)
! 61: * sntp timeout:: timeout option (-t)
! 62: @end menu
! 63:
! 64: @node sntp usage
! 65: @subsection sntp usage help (-?)
! 66: @cindex sntp usage
! 67:
! 68: This is the automatically generated usage text for sntp:
! 69:
! 70: @exampleindent 0
! 71: @example
! 72: sntp - standard Simple Network Time Protocol program - Ver. 4.2.6p5
! 73: USAGE: sntp [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... \
! 74: [ hostname-or-IP ...]
! 75: Flg Arg Option-Name Description
! 76: -4 no ipv4 Force IPv4 DNS name resolution
! 77: - prohibits these options:
! 78: ipv6
! 79: -6 no ipv6 Force IPv6 DNS name resolution
! 80: - prohibits these options:
! 81: ipv4
! 82: -d no normalverbose Normal verbose
! 83: -K Str kod KoD history filename
! 84: -p no syslog Logging with syslog
! 85: - prohibits these options:
! 86: logfile
! 87: -l Str logfile Log to specified logfile
! 88: - prohibits these options:
! 89: syslog
! 90: -s no settod Set (step) the time with settimeofday()
! 91: - prohibits these options:
! 92: adjtime
! 93: -j no adjtime Set (slew) the time with adjtime()
! 94: - prohibits these options:
! 95: settod
! 96: -b Str broadcast Use broadcasts to the address specified for synchronisation
! 97: -t Num timeout Specify the number of seconds to wait for broadcasts
! 98: -a Num authentication Enable authentication with the key auth-keynumber
! 99: -k Str keyfile Specify a keyfile. SNTP will look in this file for the key specified with -a
! 100: opt version Output version information and exit
! 101: -? no help Display extended usage information and exit
! 102: -! no more-help Extended usage information passed thru pager
! 103: -> opt save-opts Save the option state to a config file
! 104: -< Str load-opts Load options from a config file
! 105: - disabled as --no-load-opts
! 106: - may appear multiple times
! 107:
! 108: Options are specified by doubled hyphens and their name or by a single
! 109: hyphen and the flag character.
! 110:
! 111:
! 112:
! 113: The following option preset mechanisms are supported:
! 114: - reading file $HOME/.ntprc
! 115: - reading file ./.ntprc
! 116: - examining environment variables named SNTP_*
! 117:
! 118: sntp implements the Simple Network Time Protocol, and is used to query an
! 119: NTP or SNTP server and either display the time or set the local system's
! 120: time (given suitable privilege).
! 121:
! 122: It can be run interactively from the command line or as a cron job.
! 123:
! 124: NTP and SNTP are defined by RFC 5905, which obsoletes RFC 4330 and RFC
! 125: 1305.
! 126:
! 127: please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org
! 128: @end example
! 129: @exampleindent 4
! 130:
! 131: @node sntp adjtime
! 132: @subsection adjtime option (-j)
! 133: @cindex sntp-adjtime
! 134:
! 135: This is the ``set (slew) the time with adjtime()'' option.
! 136:
! 137: This option has some usage constraints. It:
! 138: @itemize @bullet
! 139: @item
! 140: must not appear in combination with any of the following options:
! 141: settod.
! 142: @end itemize
! 143:
! 144:
! 145:
! 146: @node sntp authentication
! 147: @subsection authentication option (-a)
! 148: @cindex sntp-authentication
! 149:
! 150: This is the ``enable authentication with the key auth-keynumber'' option.
! 151: This option enables authentication using the key specified in this option's argument.
! 152: The argument of this option is the keyid, a number specified in the keyfile as this
! 153: key's identifier. See the keyfile option (-k) for more details.
! 154:
! 155: @node sntp broadcast
! 156: @subsection broadcast option (-b)
! 157: @cindex sntp-broadcast
! 158:
! 159: This is the ``use broadcasts to the address specified for synchronisation'' option.
! 160: If specified SNTP will listen to the specified broadcast address
! 161: for NTP broadcasts. The default maximum wait time,
! 162: 68 seconds, can be modified with -t.
! 163:
! 164: @node sntp ipv4
! 165: @subsection ipv4 option (-4)
! 166: @cindex sntp-ipv4
! 167:
! 168: This is the ``force ipv4 dns name resolution'' option.
! 169:
! 170: This option has some usage constraints. It:
! 171: @itemize @bullet
! 172: @item
! 173: must not appear in combination with any of the following options:
! 174: ipv6.
! 175: @end itemize
! 176:
! 177: Force DNS resolution of the following host names on the command line
! 178: to the IPv4 namespace.
! 179:
! 180: @node sntp ipv6
! 181: @subsection ipv6 option (-6)
! 182: @cindex sntp-ipv6
! 183:
! 184: This is the ``force ipv6 dns name resolution'' option.
! 185:
! 186: This option has some usage constraints. It:
! 187: @itemize @bullet
! 188: @item
! 189: must not appear in combination with any of the following options:
! 190: ipv4.
! 191: @end itemize
! 192:
! 193: Force DNS resolution of the following host names on the command line
! 194: to the IPv6 namespace.
! 195:
! 196: @node sntp keyfile
! 197: @subsection keyfile option (-k)
! 198: @cindex sntp-keyfile
! 199:
! 200: This is the ``specify a keyfile. sntp will look in this file for the key specified with -a'' option.
! 201: This option specifies the keyfile. SNTP will search for the key specified with -a keyno in this
! 202: file. Key files follow the following format:
! 203:
! 204: keyid keytype key
! 205:
! 206: Where keyid is a number identifying this key
! 207: keytype is one of the follow:
! 208: S Key in 64 Bit hexadecimal number as specified in in the DES specification.
! 209: N Key in 64 Bit hexadecimal number as specified in the NTP standard.
! 210: A Key in a 1-to-8 character ASCII string.
! 211: M Key in a 1-to-8 character ASCII string using the MD5 authentication scheme.
! 212:
! 213: For more information see ntp.keys(5).
! 214:
! 215: @node sntp kod
! 216: @subsection kod option (-K)
! 217: @cindex sntp-kod
! 218:
! 219: This is the ``kod history filename'' option.
! 220: Specifies the filename to be used to persist the history of KoD
! 221: responses received from servers. The default is
! 222: /var/db/ntp-kod.
! 223:
! 224: @node sntp logfile
! 225: @subsection logfile option (-l)
! 226: @cindex sntp-logfile
! 227:
! 228: This is the ``log to specified logfile'' option.
! 229:
! 230: This option has some usage constraints. It:
! 231: @itemize @bullet
! 232: @item
! 233: must not appear in combination with any of the following options:
! 234: syslog.
! 235: @end itemize
! 236:
! 237: This option causes the client to write log messages to the specified
! 238: logfile.
! 239:
! 240: @node sntp normalverbose
! 241: @subsection normalverbose option (-d)
! 242: @cindex sntp-normalverbose
! 243:
! 244: This is the ``normal verbose'' option.
! 245: Diagnostic messages for non-fatal errors and a limited amount of
! 246: tracing should be written to standard error. Fatal ones always
! 247: produce a diagnostic. This option should be set when there is a
! 248: suspected problem with the server, network or the source.
! 249:
! 250: @node sntp settod
! 251: @subsection settod option (-s)
! 252: @cindex sntp-settod
! 253:
! 254: This is the ``set (step) the time with settimeofday()'' option.
! 255:
! 256: This option has some usage constraints. It:
! 257: @itemize @bullet
! 258: @item
! 259: must not appear in combination with any of the following options:
! 260: adjtime.
! 261: @end itemize
! 262:
! 263:
! 264:
! 265: @node sntp syslog
! 266: @subsection syslog option (-p)
! 267: @cindex sntp-syslog
! 268:
! 269: This is the ``logging with syslog'' option.
! 270:
! 271: This option has some usage constraints. It:
! 272: @itemize @bullet
! 273: @item
! 274: must not appear in combination with any of the following options:
! 275: logfile.
! 276: @end itemize
! 277:
! 278: When this option is set all logging will be done using syslog.
! 279:
! 280: @node sntp timeout
! 281: @subsection timeout option (-t)
! 282: @cindex sntp-timeout
! 283:
! 284: This is the ``specify the number of seconds to wait for broadcasts'' option.
! 285: When waiting for a broadcast packet SNTP will wait the number
! 286: of seconds specified before giving up. Default 68 seconds.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to sntp-opts.texi CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / ntp / sntp