'\" t
.\"     Title: ntptime
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2021-06-17
.\"    Manual: NTPsec
.\"    Source: NTPsec
.\"  Language: English
.\"
.TH "NTPTIME" "8" "2021-06-17" "NTPsec" "NTPsec"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ntptime \- read and set kernel time variables
.SH "SYNOPSIS"
.sp
.sp
.nf
ntptime [\f(CR\-chr\fP] [\f(CR\-e\fP \fIest_error\fP] [\f(CR\-f\fP \fIfrequency\fP] [\-j]
        [\f(CR\-m\fP \fImax_error\fP] [\f(CR\-o\fP \fIoffset\fP] [\f(CR\-s\fP \fIstatus\fP]
        [\f(CR\-t\fP \fItime_constant\fP]
.fi
.br
.SH "DESCRIPTION"
.sp
Checks the kernel configuration for the NTP user interface
syscalls \f(CRntp_gettime()\fP and \f(CRntp_adjtime()\fP.  If present, the current
timekeeping data are displayed.  If not, a disappointment is
displayed.  See the kernel page file in the HTML documentation in
distribution for further details.
.sp
A similar display can be obtained using the \f(CRntpq\fP program
and \f(CRkerninfo\fP command.
.sp
This program is useful only with kernels featuring the ntp_adjtime(2)
system call or local equivalent, as described in the \c
.URL "kern.html" "A
Kernel Model for Precision Timekeeping"  page,
.SH "OPTIONS"
.sp
\f(CR\-c\fP
.RS 4
Display the execution time of \f(CRntptime\fP itself.
.RE
.sp
\f(CR\-e\fP \fIest_error\fP
.RS 4
Specify estimated error, in microseconds.
.RE
.sp
\f(CR\-f\fP \fIfrequency\fP
.RS 4
Specify frequency offset, in parts per million.
.RE
.sp
\f(CR\-h\fP
.RS 4
Display help information.
.RE
.sp
\f(CR\-j\fP
.RS 4
Report in JSON rather than plain text.
.RE
.sp
\f(CR\-m\fP \fImax_error\fP
.RS 4
Specify max possible errors, in microseconds.
.RE
.sp
\f(CR\-o\fP \fIoffset\fP
.RS 4
Specify clock offset, in microseconds.
.RE
.sp
\f(CR\-r\fP
.RS 4
Display Unix and NTP times in raw format.
.RE
.sp
\f(CR\-s\fP \fIstatus\fP
.RS 4
Specify clock status. Better know what you are doing.
.RE
.sp
\f(CR\-t\fP \fItime_constant\fP
.RS 4
Specify time constant, an integer in the range 0\-10.
.RE
.sp
\f(CR\-V\fP
.RS 4
Print the version string and exit.
.RE
.SH "BUGS"
.sp
The format for modes and status in the JSON report is less than ideal.
.SH "EXIT STATUS"
.sp
One of the following exit values will be returned:
.sp
0 (EXIT_SUCCESS)
.RS 4
Successful program execution.
.RE
.sp
1 (EXIT_FAILURE)
.RS 4
The operation failed or the command invocation was not valid.
.RE