xref: /freebsd/lib/libutil/ftime.3 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd May 28, 2024
29.Dt FTIME 3
30.Os
31.Sh NAME
32.Nm ftime
33.Nd get date and time
34.Sh LIBRARY
35.Lb libutil
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/timeb.h
39.Ft int
40.Fn ftime "struct timeb *tp"
41.Sh DESCRIPTION
42.Bf -symbolic
43This interface is obsoleted by
44.Xr gettimeofday 2 .
45.Ef
46.Pp
47The
48.Fn ftime
49routine fills in a structure pointed to by its argument,
50as defined by
51.In sys/timeb.h :
52.Bd -literal -offset indent
53/*
54 * Structure returned by ftime system call
55 */
56struct timeb
57{
58	  time_t  time;
59	  unsigned short millitm;
60	  short   timezone;
61	  short   dstflag;
62};
63.Ed
64.Pp
65The structure contains the time since the epoch in seconds,
66up to 1000 milliseconds of more-precise interval,
67The kernel no longer maintains the timezone and dstflag info, so 0 is
68always returned for these fields.
69.Sh SEE ALSO
70.Xr gettimeofday 2 ,
71.Xr settimeofday 2 ,
72.Xr ctime 3 ,
73.Xr time 3
74.Sh HISTORY
75The
76.Nm
77function appeared in
78.At v7 .
79