components/ntp/manpages/ntptime.1m
changeset 172 093198acf7d4
child 181 87e11e685b1f
equal deleted inserted replaced
171:dbff1afe6b31 172:093198acf7d4
       
     1 '\" te
       
     2 .\" CDDL HEADER START
       
     3 .\"
       
     4 .\" The contents of this file are subject to the terms of the
       
     5 .\" Common Development and Distribution License (the "License").
       
     6 .\" You may not use this file except in compliance with the License.
       
     7 .\"
       
     8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
       
     9 .\" or http://www.opensolaris.org/os/licensing.
       
    10 .\" See the License for the specific language governing permissions
       
    11 .\" and limitations under the License.
       
    12 .\"
       
    13 .\" When distributing Covered Code, include this CDDL HEADER in each
       
    14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
       
    15 .\" If applicable, add the following below this CDDL HEADER, with the
       
    16 .\" fields enclosed by brackets "[]" replaced with your own identifying
       
    17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
       
    18 .\"
       
    19 .\" CDDL HEADER END
       
    20 .\"
       
    21 .\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
       
    22 .\"
       
    23 .TH "ntptime" "1M" "" "" "System Administration Commands"
       
    24 .SH NAME
       
    25 ntptime \- Display Kernel Time Variables.
       
    26 .SH SYNOPSIS
       
    27 .LP
       
    28 .n
       
    29 \fB/usr/sbin/ntptime\fR [\fB-chr\fR] [\fB-e\fR \fIest_error\fR] [\fB-f\fR \fIfrequency\fR]
       
    30  [\fB-m\fR \fImax_error\fR] [\fB-o\fR \fIoffset\fR] [\fB-s\fR \fIstatus\fR] [\fB-t\fR \fItime_constant\fR]
       
    31 .fi
       
    32 .SH "DESCRIPTION"
       
    33 This program is used to display or set the kernel variables used by NTP as described in the documentation at 
       
    34 file:///usr/share/doc/ntp/kern.html entitled "A Kernel Model for Precision Timekeeping". A similar display can 
       
    35 be obtained using the \fBntpdc\fP program and \fBkerninfo\fP command. The actual meaning of these variables
       
    36 is rather difficult to understand, but the \fBntptime\fP program is primarily useful to determine if the variables
       
    37 are set at all or to clear them if they are.
       
    38 .SH "OPTIONS"
       
    39 .TP
       
    40 .BR "-c"
       
    41 Display the time taken to call ntp_gettime (us)
       
    42 .TP
       
    43 .BR "-e \fIesterror\fP"
       
    44 Set the estimated error, in microseconds.
       
    45 .TP
       
    46 .BR "-f \fIfrequency\fP"
       
    47 Set the frequency error (-500 .. 500), in parts per million.
       
    48 .TP
       
    49 .BR "-h"
       
    50 Display help information.
       
    51 .TP
       
    52 .BR "-m \fImaxerror\fP"
       
    53 Set the maximum possible error, in microseconds.
       
    54 .TP
       
    55 .BR "-o \fIoffset\fP"
       
    56 Set the offset in microseconds.
       
    57 .TP
       
    58 .BR "-r"
       
    59 Print the unix and NTP time raw
       
    60 .TP
       
    61 .BR "-s \fIstatus\fP"
       
    62 Set the status bits. Do not use this unless you know what you are doing.
       
    63 .TP
       
    64 .BR "-t \fItimeconstant\fP"
       
    65 Set the log2 of PLL time constant, an integer in the range 0-10.
       
    66 .SH NOTES
       
    67 .LP
       
    68 Source for \fBntptime\fR is available on http://src.opensolaris.org.
       
    69 .LP
       
    70 The documentation available at /usr/share/doc/ntp is provided as is from the
       
    71 \fBNTP\fR distribution and may contain information that is not applicable to
       
    72 the software as provided in this partIcular distribution.
       
    73 .SH ATTRIBUTES
       
    74 See
       
    75 .BR attributes (5)
       
    76 for descriptions of the following attributes:
       
    77 .sp
       
    78 .TS
       
    79 tab() box;
       
    80 cw(2.75i) |cw(2.75i)
       
    81 lw(2.75i) |lw(2.75i)
       
    82 .
       
    83 ATTRIBUTE TYPEATTRIBUTE VALUE
       
    84 _
       
    85 Availabilityservice/network/ntp
       
    86 =
       
    87 Interface StabilityVolatile
       
    88 .TE
       
    89 .PP
       
    90 .SH SEE ALSO
       
    91 .LP
       
    92 \fBntpd\fR(1M), \fBattributes\fR(5)