lib/libcompat/4.1/ftime.3

   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 .\" 4. 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 .\"     @(#)ftime.3     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libcompat/4.1/ftime.3,v 1.6.2.4 2001/12/17 10:08:28 ru Exp $
  30 .\" $DragonFly: src/lib/libcompat/4.1/ftime.3,v 1.3 2006/05/26 19:39:38 swildner Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt FTIME 3
  34 .Os
  35 .Sh NAME
  36 .Nm ftime
  37 .Nd get date and time
  38 .Sh LIBRARY
  39 .Lb libcompat
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In sys/timeb.h
  43 .Ft int
  44 .Fn ftime "struct timeb *tp"
  45 .Sh DESCRIPTION
  46 .Bf -symbolic
  47 This interface is obsoleted by
  48 .Xr gettimeofday 2 .
  49 .Ef
  50 .Pp
  51 The
  52 .Fn ftime
  53 routine fills in a structure pointed to by its argument,
  54 as defined by
  55 .In sys/timeb.h :
  56 .Bd -literal -offset indent
  57 /*
  58  * Structure returned by ftime system call
  59  */
  60 struct timeb
  61 {
  62           time_t  time;
  63           unsigned short millitm;
  64           short   timezone;
  65           short   dstflag;
  66 };
  67 .Ed
  68 .Pp
  69 The structure contains the time since the epoch in seconds,
  70 up to 1000 milliseconds of more-precise interval,
  71 the local time zone (measured in minutes of time westward from Greenwich),
  72 and a flag that, if nonzero, indicates that
  73 Daylight Saving time applies locally during the appropriate part of the year.
  74 .Sh SEE ALSO
  75 .Xr gettimeofday 2 ,
  76 .Xr settimeofday 2 ,
  77 .Xr ctime 3 ,
  78 .Xr time 3
  79 .Sh HISTORY
  80 The
  81 .Nm
  82 function appeared in
  83 .Bx 4.2 .