'\" t
.\"     Title: ntptime
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 07/04/2021
.\"    Manual: NTPsec
.\"    Source: NTPsec 1.2.0
.\"  Language: English
.\"
.TH "NTPTIME" "8" "07/04/2021" "NTPsec 1\&.2\&.0" "NTPsec"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ntptime \- read and set kernel time variables
.SH "SYNOPSIS"
.sp
.nf
ntptime [\-chr] [\-e \fIest_error\fR] [\-f \fIfrequency\fR] [\-j]
        [\-m \fImax_error\fR] [\-o \fIoffset\fR] [\-s \fIstatus\fR]
        [\-t \fItime_constant\fR]
.fi
.SH "DESCRIPTION"
.sp
Checks the kernel configuration for the NTP user interface syscalls ntp_gettime() and ntp_adjtime()\&. 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 ntpq program and kerninfo command\&.
.sp
This program is useful only with kernels featuring the ntp_adjtime(2) system call or local equivalent, as described in the A Kernel Model for Precision Timekeeping page,
.SH "OPTIONS"
.PP
\-c
.RS 4
Display the execution time of
ntptime
itself\&.
.RE
.PP
\-e \fIest_error\fR
.RS 4
Specify estimated error, in microseconds\&.
.RE
.PP
\-f \fIfrequency\fR
.RS 4
Specify frequency offset, in parts per million\&.
.RE
.PP
\-h
.RS 4
Display help information\&.
.RE
.PP
\-j
.RS 4
Report in JSON rather than plain text\&.
.RE
.PP
\-m \fImax_error\fR
.RS 4
Specify max possible errors, in microseconds\&.
.RE
.PP
\-o \fIoffset\fR
.RS 4
Specify clock offset, in microseconds\&.
.RE
.PP
\-r
.RS 4
Display Unix and NTP times in raw format\&.
.RE
.PP
\-s \fIstatus\fR
.RS 4
Specify clock status\&. Better know what you are doing\&.
.RE
.PP
\-t \fItime_constant\fR
.RS 4
Specify time constant, an integer in the range 0\-10\&.
.RE
.PP
\-V
.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:
.PP
0 (EXIT_SUCCESS)
.RS 4
Successful program execution\&.
.RE
.PP
1 (EXIT_FAILURE)
.RS 4
The operation failed or the command invocation was not valid\&.
.RE