aboutsummaryrefslogtreecommitdiff
path: root/ntpd/ntpd.1
diff options
context:
space:
mode:
Diffstat (limited to 'ntpd/ntpd.1')
-rw-r--r--ntpd/ntpd.193
1 files changed, 68 insertions, 25 deletions
diff --git a/ntpd/ntpd.1 b/ntpd/ntpd.1
index ec0a0ed75fa6..baa7b8b9e291 100644
--- a/ntpd/ntpd.1
+++ b/ntpd/ntpd.1
@@ -1,7 +1,7 @@
-.TH NTPD 1 2009-12-08 "( 4.2.4p8)" "Programmer's Manual"
+.TH NTPD 1 2011-12-24 "( 4.2.6p5)" "Programmer's Manual"
.\" EDIT THIS FILE WITH CAUTION (ntpd.1)
.\"
-.\" It has been AutoGen-ed Tuesday December 8, 2009 at 08:13:11 AM EST
+.\" It has been AutoGen-ed December 24, 2011 at 06:34:12 PM by AutoGen 5.12
.\" From the definitions ntpd-opts.def
.\" and the template file agman1.tpl
.\"
@@ -14,20 +14,22 @@ ntpd \- NTP daemon program
.PP
All arguments must be options.
.SH "DESCRIPTION"
-This manual page documents, briefly, the \fBntpd\fP command.
+This manual page briefly documents the \fBntpd\fP command.
.SH OPTIONS
.TP
.BR \-4 ", " \--ipv4
Force IPv4 DNS name resolution.
-This option is a member of the ipv4 class of options.
+This option must not appear in combination with any of the following options:
+ipv6.
.sp
Force DNS resolution of following host names on the command line
to the IPv4 namespace.
.TP
.BR \-6 ", " \--ipv6
Force IPv6 DNS name resolution.
-This option is a member of the ipv4 class of options.
+This option must not appear in combination with any of the following options:
+ipv4.
.sp
Force DNS resolution of following host names on the command line
to the IPv6 namespace.
@@ -89,6 +91,7 @@ file.
.TP
.BR \-g ", " \--panicgate
Allow the first adjustment to be Big.
+This option may appear an unlimited number of times.
.sp
Normally,
ntpd
@@ -109,16 +112,27 @@ Jail directory.
Chroot the server to the directory
jaildir
.
-This 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.
+This option also implies that the server attempts to drop root privileges at startup.
You may need to also specify a
-u
option.
+This option is only available if the OS supports adjusting the clock
+without full root privileges.
+This option is supported under NetBSD (configure with
+--enable-clockctl
+) and Linux (configure with
+--enable-linuxcaps
+).
.TP
.BR \-I " \fIiface\fP, " \--interface "=" \fIiface\fP
-Listen on interface.
+Listen on an interface name or address.
This option may appear an unlimited number of times.
.sp
-
+Open the network address given, or all the addresses associated with the
+given interface name. This option may appear multiple times. This option
+also implies not opening other addresses, except wildcard and localhost.
+This option is deprecated. Please consider using the configuration file
+interface command, which is more versatile.
.TP
.BR \-k " \fIstring\fP, " \--keyfile "=" \fIstring\fP
path to symmetric keys.
@@ -140,14 +154,19 @@ logfile logfile
configuration file directive.
.TP
.BR \-L ", " \--novirtualips
-Do not listen to virtual IPs.
+Do not listen to virtual interfaces.
.sp
-Do not listen to virtual IPs. The default is to listen.
+Do not listen to virtual interfaces, defined as those with
+names containing a colon. This option is deprecated. Please
+consider using the configuration file interface command, which
+is more versatile.
.TP
.BR \-M ", " \--modifymmtimer
Modify Multimedia Timer (Windows only).
.sp
-Set the Windows Multimedia Timer to highest resolution.
+Set the Windows Multimedia Timer to highest resolution. This
+ensures the resolution does not change while ntpd is running,
+avoiding timekeeping glitches associated with changes.
.TP
.BR \-n ", " \--nofork
Do not fork.
@@ -200,14 +219,12 @@ Broadcast/propagation delay.
.sp
Specify 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.
.TP
-.BR \-U " \fInumber\fP, " \--updateinterval "=" \fInumber\fP
-interval in seconds between scans for new or dropped interfaces.
-This option takes an integer number as its argument.
+.BR \--saveconfigquit "=\fIstring\fP"
+Save parsed configuration and quit.
.sp
-Give the time in seconds between two scans for new or dropped interfaces.
-For systems with routing socket support the scans will be performed shortly after the interface change
-has been detected by the system.
-Use 0 to disable scanning.
+Cause ntpd to parse its startup configuration file and save an
+equivalent to the given filename and exit. This option was
+designed for automated testing.
.TP
.BR \-s " \fIstring\fP, " \--statsdir "=" \fIstring\fP
Statistics file location.
@@ -227,20 +244,30 @@ Add a key number to the trusted key list.
Run as userid (or userid:groupid).
.sp
Specify a user, and optionally a group, to switch to.
-This option is only available if the OS supports to run the server without full root privileges.
-Currently, this option is supported under NetBSD (configure with
+This option is only available if the OS supports adjusting the clock
+without full root privileges.
+This option is supported under NetBSD (configure with
--enable-clockctl
) and Linux (configure with
--enable-linuxcaps
).
.TP
-.BR \-v " \fInvar\fP, " \--var "=" \fInvar\fP
+.BR \-U " \fInumber\fP, " \--updateinterval "=" \fInumber\fP
+interval in seconds between scans for new or dropped interfaces.
+This option takes an integer number as its argument.
+.sp
+Give the time in seconds between two scans for new or dropped interfaces.
+For systems with routing socket support the scans will be performed shortly after the interface change
+has been detected by the system.
+Use 0 to disable scanning. 60 seconds is the minimum time between scans.
+.TP
+.BR \--var "=\fInvar\fP"
make ARG an ntp variable (RW).
This option may appear an unlimited number of times.
.sp
.TP
-.BR \-V " \fIndvar\fP, " \--dvar "=" \fIndvar\fP
+.BR \--dvar "=\fIndvar\fP"
make ARG an ntp variable (RW|DEF).
This option may appear an unlimited number of times.
.sp
@@ -263,13 +290,28 @@ tinker
configuration file directive for other options.
Note: The kernel time discipline is disabled with this option.
.TP
+.BR \--usepcc
+Use CPU cycle counter (Windows only).
+.sp
+Attempt to substitute the CPU counter for QueryPerformanceCounter.
+The CPU counter and QueryPerformanceCounter are compared, and if
+they have the same frequency, the CPU counter (RDTSC on x86) is
+used directly, saving the overhead of a system call.
+.TP
+.BR \--pccfreq "=\fIstring\fP"
+Force CPU cycle counter use (Windows only).
+.sp
+Force substitution the CPU counter for QueryPerformanceCounter.
+The CPU counter (RDTSC on x86) is used unconditionally with the
+given frequency (in Hz).
+.TP
.BR \-? , " \--help"
-Display usage information and exit.
+Display extended usage information and exit.
.TP
.BR \-! , " \--more-help"
Extended usage information passed thru pager.
.TP
-.BR \-v " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
+.BR \- " [{\fIv|c|n\fP}]," " \--version" "[=\fI{v|c|n}\fP]"
Output version of program and exit. The default mode is `v', a simple
version. The `c' mode will print copyright information and `n' will
print the full copyright notice.
@@ -279,7 +321,7 @@ by loading values from environment variables named:
.nf
\fBNTPD_<option-name>\fP or \fBNTPD\fP
.fi
-.aj
+.ad
.SH AUTHOR
David L. Mills and/or others
.br
@@ -289,6 +331,7 @@ Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
.nf
.na
see html/copyright.html
+
.fi
.ad
.PP