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