/contrib/ntp/ntpd/ntpd.1

  1.TH NTPD 1 2009-12-08 "( 4.2.4p8)" "Programmer's Manual"
  2.\"  EDIT THIS FILE WITH CAUTION  (ntpd.1)
  3.\"  
  4.\"  It has been AutoGen-ed  Tuesday December  8, 2009 at 08:13:11 AM EST
  5.\"  From the definitions    ntpd-opts.def
  6.\"  and the template file   agman1.tpl
  7.\"
  8.SH NAME
  9ntpd \- NTP daemon program
 10.SH SYNOPSIS
 11.B ntpd
 12.\" Mixture of short (flag) options and long options
 13.RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \--\fIopt-name\fP " [[=| ]\fIvalue\fP]]..."
 14.PP
 15All arguments must be options.
 16.SH "DESCRIPTION"
 17This manual page documents, briefly, the \fBntpd\fP command.
 18
 19.SH OPTIONS
 20.TP
 21.BR \-4 ", " \--ipv4
 22Force IPv4 DNS name resolution.
 23This option is a member of the ipv4 class of options.
 24.sp
 25Force DNS resolution of following host names on the command line
 26to the IPv4 namespace.
 27.TP
 28.BR \-6 ", " \--ipv6
 29Force IPv6 DNS name resolution.
 30This option is a member of the ipv4 class of options.
 31.sp
 32Force DNS resolution of following host names on the command line
 33to the IPv6 namespace.
 34.TP
 35.BR \-a ", " \--authreq
 36Require crypto authentication.
 37This option must not appear in combination with any of the following options:
 38authnoreq.
 39.sp
 40Require cryptographic authentication for broadcast client,
 41multicast client and symmetric passive associations.
 42This is the default.
 43.TP
 44.BR \-A ", " \--authnoreq
 45Do not require crypto authentication.
 46This option must not appear in combination with any of the following options:
 47authreq.
 48.sp
 49Do not require cryptographic authentication for broadcast client,
 50multicast client and symmetric passive associations.
 51This is almost never a good idea.
 52.TP
 53.BR \-b ", " \--bcastsync
 54Allow us to sync to broadcast servers.
 55.sp
 56
 57.TP
 58.BR \-c " \fIstring\fP, " \--configfile "=" \fIstring\fP
 59configuration file name.
 60.sp
 61The name and path of the configuration file,
 62/etc/ntp.conf
 63by default.
 64.TP
 65.BR \-d ", " \--debug-level
 66Increase output debug message level.
 67This option may appear an unlimited number of times.
 68.sp
 69Increase the debugging message output level.
 70.TP
 71.BR \-D " \fIstring\fP, " \--set-debug-level "=" \fIstring\fP
 72Set the output debug message level.
 73This option may appear an unlimited number of times.
 74.sp
 75Set the output debugging level.  Can be supplied multiple times,
 76but each overrides the previous value(s).
 77.TP
 78.BR \-f " \fIstring\fP, " \--driftfile "=" \fIstring\fP
 79frequency drift file name.
 80.sp
 81The name and path of the frequency file,
 82/etc/ntp.drift
 83by default.
 84This is the same operation as the
 85driftfile driftfile
 86configuration specification in the 
 87/etc/ntp.conf
 88file.
 89.TP
 90.BR \-g ", " \--panicgate
 91Allow the first adjustment to be Big.
 92.sp
 93Normally,
 94ntpd
 95exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that,
 96ntpd
 97will exit with a message to the system log. This option can be used with the
 98-q
 99and
100-x
101options.
102See the
103tinker
104configuration file directive for other options.
105.TP
106.BR \-i " \fIstring\fP, " \--jaildir "=" \fIstring\fP
107Jail directory.
108.sp
109Chroot the server to the directory
110jaildir
111.
112This option also implies that the server attempts to drop root privileges at startup (otherwise, chroot gives very little additional security), and it is only available if the OS supports to run the server without full root privileges.
113You may need to also specify a
114-u
115option.
116.TP
117.BR \-I " \fIiface\fP, " \--interface "=" \fIiface\fP
118Listen on interface.
119This option may appear an unlimited number of times.
120.sp
121
122.TP
123.BR \-k " \fIstring\fP, " \--keyfile "=" \fIstring\fP
124path to symmetric keys.
125.sp
126Specify the name and path of the symmetric key file.
127/etc/ntp.keys
128is the default.
129This is the same operation as the
130keys keyfile
131configuration file directive.
132.TP
133.BR \-l " \fIstring\fP, " \--logfile "=" \fIstring\fP
134path to the log file.
135.sp
136Specify the name and path of the log file.
137The default is the system log file.
138This is the same operation as the
139logfile logfile
140configuration file directive.
141.TP
142.BR \-L ", " \--novirtualips
143Do not listen to virtual IPs.
144.sp
145Do not listen to virtual IPs. The default is to listen.
146.TP
147.BR \-M ", " \--modifymmtimer
148Modify Multimedia Timer (Windows only).
149.sp
150Set the Windows Multimedia Timer to highest resolution.
151.TP
152.BR \-n ", " \--nofork
153Do not fork.
154.sp
155
156.TP
157.BR \-N ", " \--nice
158Run at high priority.
159.sp
160To the extent permitted by the operating system, run
161ntpd
162at the highest priority.
163.TP
164.BR \-p " \fIstring\fP, " \--pidfile "=" \fIstring\fP
165path to the PID file.
166.sp
167Specify the name and path of the file used to record
168ntpd's
169process ID.
170This is the same operation as the
171pidfile pidfile
172configuration file directive.
173.TP
174.BR \-P " \fInumber\fP, " \--priority "=" \fInumber\fP
175Process priority.
176This option takes an integer number as its argument.
177.sp
178To the extent permitted by the operating system, run
179ntpd
180at the specified
181sched_setscheduler(SCHED_FIFO)
182priority.
183.TP
184.BR \-q ", " \--quit
185Set the time and quit.
186.sp
187ntpd
188will exit just after the first time the clock is set. This behavior mimics that of the
189ntpdate
190program, which is to be retired.
191The
192-g
193and
194-x
195options can be used with this option.
196Note: The kernel time discipline is disabled with this option.
197.TP
198.BR \-r " \fIstring\fP, " \--propagationdelay "=" \fIstring\fP
199Broadcast/propagation delay.
200.sp
201Specify the default propagation delay from the broadcast/multicast server to this client. This is necessary only if the delay cannot be computed automatically by the protocol.
202.TP
203.BR \-U " \fInumber\fP, " \--updateinterval "=" \fInumber\fP
204interval in seconds between scans for new or dropped interfaces.
205This option takes an integer number as its argument.
206.sp
207Give the time in seconds between two scans for new or dropped interfaces.
208For systems with routing socket support the scans will be performed shortly after the interface change
209has been detected by the system.
210Use 0 to disable scanning.
211.TP
212.BR \-s " \fIstring\fP, " \--statsdir "=" \fIstring\fP
213Statistics file location.
214.sp
215Specify the directory path for files created by the statistics facility.
216This is the same operation as the
217statsdir statsdir
218configuration file directive.
219.TP
220.BR \-t " \fItkey\fP, " \--trustedkey "=" \fItkey\fP
221Trusted key number.
222This option may appear an unlimited number of times.
223.sp
224Add a key number to the trusted key list.
225.TP
226.BR \-u " \fIstring\fP, " \--user "=" \fIstring\fP
227Run as userid (or userid:groupid).
228.sp
229Specify a user, and optionally a group, to switch to.
230This option is only available if the OS supports to run the server without full root privileges.
231Currently, this option is supported under NetBSD (configure with
232--enable-clockctl
233) and Linux (configure with
234--enable-linuxcaps
235).
236.TP
237.BR \-v " \fInvar\fP, " \--var "=" \fInvar\fP
238make ARG an ntp variable (RW).
239This option may appear an unlimited number of times.
240.sp
241
242.TP
243.BR \-V " \fIndvar\fP, " \--dvar "=" \fIndvar\fP
244make ARG an ntp variable (RW|DEF).
245This option may appear an unlimited number of times.
246.sp
247
248.TP
249.BR \-x ", " \--slew
250Slew up to 600 seconds.
251.sp
252Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold.
253This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
254Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s.
255Thus, an adjustment as much as 600 s will take almost 14 days to complete.
256This option can be used with the
257-g
258and
259-q
260options.
261See the
262tinker
263configuration file directive for other options.
264Note: The kernel time discipline is disabled with this option.
265.TP
266.BR \-? , " \--help"
267Display usage information and exit.
268.TP
269.BR \-! , " \--more-help"
270Extended usage information passed thru pager.
271.TP
272.BR \-v " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
273Output version of program and exit.  The default mode is `v', a simple
274version.  The `c' mode will print copyright information and `n' will
275print the full copyright notice.
276.SH OPTION PRESETS
277Any option that is not marked as \fInot presettable\fP may be preset
278by loading values from environment variables named:
279.nf
280  \fBNTPD_<option-name>\fP or \fBNTPD\fP
281.fi
282.aj
283.SH AUTHOR
284David L. Mills and/or others
285.br
286Please send bug reports to:  http://bugs.ntp.org, bugs@ntp.org
287
288.PP
289.nf
290.na
291see html/copyright.html
292.fi
293.ad
294.PP
295This manual page was \fIAutoGen\fP-erated from the \fBntpd\fP
296option definitions.