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