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