- Uniformly use .In for header file references.
[dragonfly.git] / lib / libcompat / 4.1 / ftime.3
CommitLineData
984263bc
MD
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. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" @(#)ftime.3 8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: src/lib/libcompat/4.1/ftime.3,v 1.6.2.4 2001/12/17 10:08:28 ru Exp $
44cb301e 34.\" $DragonFly: src/lib/libcompat/4.1/ftime.3,v 1.3 2006/05/26 19:39:38 swildner Exp $
984263bc
MD
35.\"
36.Dd June 4, 1993
37.Dt FTIME 3
38.Os
39.Sh NAME
40.Nm ftime
41.Nd get date and time
42.Sh LIBRARY
43.Lb libcompat
44.Sh SYNOPSIS
45.In sys/types.h
46.In sys/timeb.h
47.Ft int
48.Fn ftime "struct timeb *tp"
49.Sh DESCRIPTION
50.Bf -symbolic
51This interface is obsoleted by
52.Xr gettimeofday 2 .
53.Ef
54.Pp
55The
56.Fn ftime
57routine fills in a structure pointed to by its argument,
58as defined by
44cb301e 59.In sys/timeb.h :
984263bc
MD
60.Bd -literal -offset indent
61/*
62 * Structure returned by ftime system call
63 */
64struct timeb
65{
66 time_t time;
67 unsigned short millitm;
68 short timezone;
69 short dstflag;
70};
71.Ed
72.Pp
73The structure contains the time since the epoch in seconds,
74up to 1000 milliseconds of more-precise interval,
75the local time zone (measured in minutes of time westward from Greenwich),
76and a flag that, if nonzero, indicates that
77Daylight Saving time applies locally during the appropriate part of the year.
78.Sh SEE ALSO
79.Xr gettimeofday 2 ,
80.Xr settimeofday 2 ,
81.Xr ctime 3 ,
82.Xr time 3
83.Sh HISTORY
84The
85.Nm
86function appeared in
87.Bx 4.2 .