1.\" 2.\" Copyright (c) 2003 Tom Rhodes 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 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. 13.\" 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 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD: src/lib/libc/sys/ntp_gettime.2,v 1.1.2.1 2003/04/22 17:31:18 trhodes Exp $ 27.\" 28.Dd April 1, 2003 29.Dt NTP_GETTIME 2 30.Os 31.Sh NAME 32.Nm ntp_gettime 33.Nd NTP user application interface 34.Sh LIBRARY 35.Lb libc 36.Sh SYNOPSIS 37.In sys/timex.h 38.Ft int 39.Fn ntp_gettime "struct ntptimeval *ntv" 40.Sh DESCRIPTION 41The time returned by 42.Fn ntp_gettime 43is in a 44.Vt timespec 45structure, but may be in either microsecond 46(seconds and microseconds) or nanosecond (seconds and nanoseconds) format. 47The particular format in use is determined by the 48.Dv STA_NANO 49bit of the status 50word returned by the 51.Fn ntp_adjtime 52system call. 53.Fn ntp_gettime 54has as argument a pointer to the 55.Vt ntptimeval 56structure with the following members: 57.Bd -literal 58struct ntptimeval { 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 */ 64}; 65.Ed 66.Pp 67These are understood as: 68.Bl -tag -width ".Va time_state" 69.It Va time 70Current time (read-only). 71.It Va maxerror 72Maximum error in microseconds (read-only). 73.It Va esterror 74Estimated error in microseconds (read-only). 75.It Va tai 76Temps Atomique International (French for International Atomic Time), 77measures real time. 78Used for acute time measurements. 79.It Va time_state 80Current time status. 81.El 82.Sh RETURN VALUES 83.Rv -std ntp_gettime 84.Pp 85Possible states of the clock are: 86.Pp 87.Bl -tag -compact -width ".Dv TIME_ERROR" 88.It Dv TIME_OK 89Everything okay, no leap second warning. 90.It Dv TIME_INS 91Insert leap second warning. 92.It Dv TIME_DEL 93Delete leap second warning. 94.It Dv TIME_OOP 95Leap second in progress. 96.It Dv TIME_WAIT 97Leap second has occurred. 98.It Dv TIME_ERROR 99Clock not synchronized. 100.El 101.Sh SEE ALSO 102.Xr ntp_adjtime 2 , 103.Xr ntpd 8 Pq Pa net/openntpd 104.Sh AUTHORS 105This manual page was written by 106.An Tom Rhodes Aq trhodes@FreeBSD.org . 107