17603117 ntpd(8) is not helpful if I need to know how to quickly set up NTP s11u3-sru
authorBrian Utterback <brian.utterback@oracle.com>
Mon, 28 Nov 2016 19:00:18 -0800
branchs11u3-sru
changeset 7537 ae530156d261
parent 7536 4b46a2f22fdf
child 7538 1668450ff96c
17603117 ntpd(8) is not helpful if I need to know how to quickly set up NTP
components/ntp/manpages/ntp.conf.4
components/ntp/manpages/ntpd.1m
--- a/components/ntp/manpages/ntp.conf.4	Mon Nov 28 19:00:01 2016 -0800
+++ b/components/ntp/manpages/ntp.conf.4	Mon Nov 28 19:00:18 2016 -0800
@@ -18,7 +18,7 @@
 .\"
 .\" CDDL HEADER END
 .\"
-.\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
+.\" Copyright (c) 2009, 2017, Oracle and/or its affiliates. All rights reserved.
 .\"
 .TH "ntp.conf" "4" "" "" "File Formats"
 .SH NAME
@@ -219,7 +219,7 @@
 .RS 4n
 Specifies the version number to be used for outgoing NTP packets. Versions 1-4 are the choices, with version 4 the default.
 .RE
-.SS "Auxilliary Commands"
+.SS "Auxiliary Commands"
 .sp .3
 .ne 2
 .mk
--- a/components/ntp/manpages/ntpd.1m	Mon Nov 28 19:00:01 2016 -0800
+++ b/components/ntp/manpages/ntpd.1m	Mon Nov 28 19:00:18 2016 -0800
@@ -18,7 +18,7 @@
 .\"
 .\" CDDL HEADER END
 .\"
-.\" Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
+.\" Copyright (c) 2009, 2017, Oracle and/or its affiliates. All rights reserved.
 .\"
 .TH "ntpd" "1M" "" "" "System Administration Commands"
 .SH NAME
@@ -105,6 +105,7 @@
 .BR \-c " \fIstring\fP, " \--configfile "=" \fIstring\fP
 The name and path of the configuration file,
 /etc/inet/ntp.conf by default.
+If the file does not exist the \fBNTP\fP service will not start.
 .TP
 .BR \-d ", " \--debug-level
 Increase output debug message level.
@@ -271,7 +272,7 @@
 An integer specifying the level of debugging requested. A zero means no debugging. The default is zero.
 .TP
 .BR config/logfile
-A string specifying the location of the file used for log output. The default is /var/ntp/ntp.log
+A string specifying the location of the file used for log output. The default is /var/ntp/ntp.log.
 .TP
 .BR config/no_auth_required
 A boolean which when true, specifies that anonymous servers such as broadcast, multicast and active peers 
@@ -295,6 +296,10 @@
 time the system clock is synchronized. This can potetially delay the system start up by a significant amount. The
 default is false.
 .TP
+.BR config/disable_local_time_adjustment
+A boolean which when true, causes the \fBNTP\fP service to be run without the privilege to adjust the system clock. When false the privilege is
+required to be present, otherwise the daemon will not start. The default is false.
+.TP
 .BR config/mdnsregister
 A boolean which when true, will cause the daemon to register with the network mDNS system. The default is false.
 .TP
@@ -320,9 +325,31 @@
 .LP
 When \fBntpd\fR starts it looks at the value of umask, and if zero \fBntpd\fR will set the umask to 022.
 .LP
-The documentation available at /usr/share/doc/ntp is provided as is from the 
-\fBNTP\fR distribution and may contain information that is not applicable to 
+The documentation available at /usr/share/doc/ntp is provided as is from the
+\fBNTP\fR distribution and may contain information that is not applicable to
 the software as provided in this particular distribution.
+.LP
+There are two example configuration files provided, /etc/inet/ntp.client and
+/etc/inet/ntp.server. The first provides examples and some discussion around
+the configuration information that goes into the /etc/inet/ntp.conf file. The
+second focuses exclusively on the configuration of hardware clocks for stratum
+zero servers and can be ignored by most users.
+.PP
+.SH EXAMPLES
+.LP
+The simplest way to start using the \fBNTP\fP service on a new host is to run
+the command:
+.sp
+.in +2
+.nf
+echo 'server hostname iburst' > /etc/inet/ntp.conf
+.fi
+.in -2
+.LP
+and then start the service. Replace 'hostname' with the actual hostname of an
+NTP server. You can add more lines like this one with the hostnames of more
+NTP servers, but do not configure exactly two. Four servers is optimal, but
+never use two.
 .PP
 .SH SEE ALSO
 .LP