2 .\" Copyright (c) 2003 Tom Rhodes
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" $FreeBSD: src/lib/libc/sys/ntp_gettime.2,v 1.1.2.1 2003/04/22 17:31:18 trhodes Exp $
33 .Nd NTP user application interface
39 .Fn ntp_gettime "struct ntptimeval *ntv"
45 structure, but may be in either microsecond
46 (seconds and microseconds) or nanosecond (seconds and nanoseconds) format.
47 The particular format in use is determined by the
54 has as argument a pointer to the
56 structure with the following members:
59 struct timespec time; /* current time (ns) (ro) */
60 long maxerror; /* maximum error (us) (ro) */
61 long esterror; /* estimated error (us) (ro) */
62 long tai; /* TAI offset */
63 int time_state; /* time status */
67 These are understood as:
68 .Bl -tag -width ".Va time_state"
70 Current time (read-only).
72 Maximum error in microseconds (read-only).
74 Estimated error in microseconds (read-only).
76 Temps Atomique International (French for International Atomic Time),
78 Used for acute time measurements.
85 Possible states of the clock are:
87 .Bl -tag -compact -width ".Dv TIME_ERROR"
89 Everything okay, no leap second warning.
91 Insert leap second warning.
93 Delete leap second warning.
95 Leap second in progress.
97 Leap second has occurred.
99 Clock not synchronized.
103 .Xr ntpd 8 Pq Pa net/openntpd
105 This manual page was written by
106 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org .