components/ntp/manpages/ntpd.8
changeset 7418 13f198c70f3c
parent 5007 0052258cbb9d
child 7542 584fcbe31c57
equal deleted inserted replaced
7417:799c7022804e 7418:13f198c70f3c
       
     1 config/ignore_time_adjustment_errors
     1 '\" te
     2 '\" te
     2 .\" CDDL HEADER START
     3 .\" CDDL HEADER START
     3 .\"
     4 .\"
     4 .\" The contents of this file are subject to the terms of the
     5 .\" The contents of this file are subject to the terms of the
     5 .\" Common Development and Distribution License (the "License").
     6 .\" Common Development and Distribution License (the "License").
    16 .\" fields enclosed by brackets "[]" replaced with your own identifying
    17 .\" fields enclosed by brackets "[]" replaced with your own identifying
    17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
    18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
    18 .\"
    19 .\"
    19 .\" CDDL HEADER END
    20 .\" CDDL HEADER END
    20 .\"
    21 .\"
    21 .\" Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
    22 .\" Copyright (c) 2009, 2016, Oracle and/or its affiliates. All rights reserved.
    22 .\"
    23 .\"
    23 .TH "ntpd" "8" "" "" "System Administration Commands"
    24 .TH "ntpd" "8" "" "" "System Administration Commands"
    24 .SH NAME
    25 .SH NAME
    25 ntpd \- Network Time Protocol daemon Version 4
    26 ntpd \- Network Time Protocol daemon Version 4
    26 .SH SYNOPSIS
    27 .SH SYNOPSIS
   102 Enable the client to sync to broadcast servers.
   103 Enable the client to sync to broadcast servers.
   103 .sp
   104 .sp
   104 .TP
   105 .TP
   105 .BR \-c " \fIstring\fP, " \--configfile "=" \fIstring\fP
   106 .BR \-c " \fIstring\fP, " \--configfile "=" \fIstring\fP
   106 The name and path of the configuration file,
   107 The name and path of the configuration file,
   107 /etc/inet/ntp.conf by default.
   108 /etc/inet/ntp.conf by default. This file must be readable by the user "daemon".
       
   109 If the file does not exist the \fBNTP\fP service will not start.
   108 .TP
   110 .TP
   109 .BR \-d ", " \--debug-level
   111 .BR \-d ", " \--debug-level
   110 Increase output debug message level.
   112 Increase output debug message level.
   111 This option may appear an unlimited number of times.
   113 This option may appear an unlimited number of times.
   112 .TP
   114 .TP
   139 /etc/inet/ntp.keys
   141 /etc/inet/ntp.keys
   140 is the default.
   142 is the default.
   141 .TP
   143 .TP
   142 .BR \-l " \fIstring\fP, " \--logfile "=" \fIstring\fP
   144 .BR \-l " \fIstring\fP, " \--logfile "=" \fIstring\fP
   143 Specify the name and path of the log file.
   145 Specify the name and path of the log file.
   144 The default is the system log file.
   146 The default is the system log file. If logging is enabled to the logfile, the
       
   147 logfile must be in a directory that is writable by the user "daemon" and if the
       
   148 file already exists, it also must be writeable by the user "daemon".
   145 .TP
   149 .TP
   146 .BR \-L ", " \--novirtualips
   150 .BR \-L ", " \--novirtualips
   147 Do not listen to virtual IPs. The default is to listen.
   151 Do not listen to virtual IPs. The default is to listen.
   148 .TP
   152 .TP
   149 .BR \-m ", " \--mdns
   153 .BR \-m ", " \--mdns
   269 .TP
   273 .TP
   270 .BR config/debuglevel
   274 .BR config/debuglevel
   271 An integer specifying the level of debugging requested. A zero means no debugging. The default is zero.
   275 An integer specifying the level of debugging requested. A zero means no debugging. The default is zero.
   272 .TP
   276 .TP
   273 .BR config/logfile
   277 .BR config/logfile
   274 A string specifying the location of the file used for log output. The default is /var/ntp/ntp.log
   278 A string specifying the location of the file used for log output. The default is /var/ntp/ntp.log. The
       
   279 log file must be writable by the user "daemon" andmust be in a directory writeable by that user.
   275 .TP
   280 .TP
   276 .BR config/no_auth_required
   281 .BR config/no_auth_required
   277 A boolean which when true, specifies that anonymous servers such as broadcast, multicast and active peers 
   282 A boolean which when true, specifies that anonymous servers such as broadcast, multicast and active peers 
   278 can be accepted without any pre-configured keys. This is very insecure and should only be used if
   283 can be accepted without any pre-configured keys. This is very insecure and should only be used if
   279 the nework is secure and all the systems on it are trusted. The default is false.
   284 the nework is secure and all the systems on it are trusted. The default is false.
   293 .BR config/wait_for_sync
   298 .BR config/wait_for_sync
   294 A boolean which when true, causes the \fBNTP\fP service to delay coming completely on-line until after the first 
   299 A boolean which when true, causes the \fBNTP\fP service to delay coming completely on-line until after the first 
   295 time the system clock is synchronized. This can potetially delay the system start up by a significant amount. The
   300 time the system clock is synchronized. This can potetially delay the system start up by a significant amount. The
   296 default is false.
   301 default is false.
   297 .TP
   302 .TP
       
   303 .BR config/ignore_time_adjustment_errors
       
   304 A boolean which when true, causes the \fBNTP\fP service to skip checking for the privileges that allow it to 
       
   305 adjust the system clock. The default is false. 
       
   306 .TP
   298 .BR config/mdnsregister
   307 .BR config/mdnsregister
   299 A boolean which when true, will cause the daemon to register with the network mDNS system. The default is false.
   308 A boolean which when true, will cause the daemon to register with the network mDNS system. The default is false.
   300 .TP
   309 .TP
   301 .BR config/verbose_logging
   310 .BR config/verbose_logging
   302 A boolean which when true, cause the daemon to issue logging messages. The default is false.
   311 A boolean which when true, cause the daemon to issue logging messages. The default is false.
   318 .LP
   327 .LP
   319 Various internal \fBntpd\fR variables can be displayed and configuration options altered while the \fBntpd\fR is running using the \fBntpq\fR and \fBntpdc\fR utility programs.
   328 Various internal \fBntpd\fR variables can be displayed and configuration options altered while the \fBntpd\fR is running using the \fBntpq\fR and \fBntpdc\fR utility programs.
   320 .LP
   329 .LP
   321 When \fBntpd\fR starts it looks at the value of umask, and if zero \fBntpd\fR will set the umask to 022.
   330 When \fBntpd\fR starts it looks at the value of umask, and if zero \fBntpd\fR will set the umask to 022.
   322 .LP
   331 .LP
   323 The documentation available at /usr/share/doc/ntp is provided as is from the 
   332 The documentation available at /usr/share/doc/ntp is provided as is from the
   324 \fBNTP\fR distribution and may contain information that is not applicable to 
   333 \fBNTP\fR distribution and may contain information that is not applicable to
   325 the software as provided in this particular distribution.
   334 the software as provided in this particular distribution.
       
   335 .LP
       
   336 The ntpd daemon now runs as the user "daemon". Care must be taken if it is
       
   337 configured to read or write files other than in the directories /etc/inet and
       
   338 /var/ntp. Any other locations will require that the user daemon have the proper
       
   339 permissions to access the files. 
       
   340 .LP
       
   341 There are two example configuration files provided, /etc/inet/ntp.client and
       
   342 /etc/inet/ntp.server. The first provides examples and some discussion around
       
   343 the configuration information that goes into the /etc/inet/ntp.conf file. The
       
   344 second focuses exclusively on the configuration of hardware clocks for stratum
       
   345 zero servers and can be ignored by most users.
       
   346 .PP
       
   347 .SH EXAMPLES
       
   348 .LP
       
   349 The simplest way to start using the \fBNTP\fP service on a new host is to run
       
   350 the command:
       
   351 .sp
       
   352 .in +2
       
   353 .nf
       
   354 echo 'server hostname iburst' > /etc/inet/ntp.conf
       
   355 .fi
       
   356 .in -2
       
   357 .LP
       
   358 and then start the service. Replace 'hostname' with the actual hostname of an
       
   359 NTP server. You can add more lines like this one with the hostnames of more
       
   360 NTP servers, but do not configure exactly two. Four servers is optimal, but
       
   361 never use two.
   326 .PP
   362 .PP
   327 .SH SEE ALSO
   363 .SH SEE ALSO
   328 .LP
   364 .LP
   329 \fBsvcs\fR(1), \fBsntp\fR(8), \fBntp-keygen\fR(8), \fBntpdate\fR(8), \fBntpq\fR(8), \fBntptrace\fR(8), \fBntptime\fR(8), \fBsvcadm\fR(8), \fBntpdc\fR(8), \fBrename\fR(2), \fBattributes\fR(7), \fBsmf\fR(7)
   365 \fBsvcs\fR(1), \fBsntp\fR(8), \fBntp-keygen\fR(8), \fBntpdate\fR(8), \fBntpq\fR(8), \fBntptrace\fR(8), \fBntptime\fR(8), \fBsvcadm\fR(8), \fBntpdc\fR(8), \fBrename\fR(2), \fBattributes\fR(7), \fBsmf\fR(7)
   330 
   366