lib/libc/sys/gettimeofday.2

   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 .\"     @(#)gettimeofday.2      8.2 (Berkeley) 5/26/95
  29 .\" $FreeBSD: src/lib/libc/sys/gettimeofday.2,v 1.9.2.9 2003/02/11 06:05:00 nsayer Exp $
  30 .\"
  31 .Dd June 17, 2019
  32 .Dt GETTIMEOFDAY 2
  33 .Os
  34 .Sh NAME
  35 .Nm gettimeofday ,
  36 .Nm settimeofday
  37 .Nd get/set date and time
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/time.h
  42 .Ft int
  43 .Fn gettimeofday "struct timeval *tp" "struct timezone *tzp"
  44 .Ft int
  45 .Fn settimeofday "const struct timeval *tp" "const struct timezone *tzp"
  46 .Sh DESCRIPTION
  47 .Bf -symbolic
  48 Note: The
  49 .Fn gettimeofday
  50 and
  51 .Fn settimeofday
  52 functions are obsolescent.
  53 Applications should use the
  54 .Fn clock_gettime
  55 and
  56 .Fn clock_settime
  57 functions instead.
  58 .Ef
  59 .Pp
  60 The system's notion of the current Greenwich time and the current time
  61 zone is obtained with the
  62 .Fn gettimeofday
  63 call, and set with the
  64 .Fn settimeofday
  65 call.  The time is expressed in seconds and microseconds
  66 since midnight (0 hour), January 1, 1970.  The resolution of the system
  67 clock is hardware dependent, and the time may be updated continuously or
  68 in
  69 .Dq ticks .
  70 If
  71 .Fa tp
  72 or
  73 .Fa tzp
  74 is NULL, the associated time
  75 information will not be returned or set.
  76 .Pp
  77 The structures pointed to by
  78 .Fa tp
  79 and
  80 .Fa tzp
  81 are defined in
  82 .In sys/time.h
  83 as:
  84 .Bd -literal
  85 struct timeval {
  86         long    tv_sec;         /* seconds since Jan. 1, 1970 */
  87         long    tv_usec;        /* and microseconds */
  88 };
  89
  90 struct timezone {
  91         int     tz_minuteswest; /* minutes west of Greenwich */
  92         int     tz_dsttime;     /* type of dst correction */
  93 };
  94 .Ed
  95 .Pp
  96 The
  97 .Fa timezone
  98 structure indicates the local time zone
  99 (measured in minutes of time westward from Greenwich),
 100 and a flag that, if nonzero, indicates that
 101 Daylight Saving time applies locally during
 102 the appropriate part of the year.
 103 .Pp
 104 Only the super-user may set the time of day or time zone.
 105 If the system is running at securelevel \(>= 2 (see
 106 .Xr init 8 ) ,
 107 the time may only be advanced or retarded by a maximum of one second.
 108 This limitation is imposed to prevent a malicious super-user
 109 from setting arbitrary time stamps on files.
 110 The system time can be adjusted backwards without restriction using the
 111 .Xr adjtime 2
 112 system call even when the system is secure.
 113 .Sh RETURN VALUES
 114 .Rv -std
 115 .Sh ERRORS
 116 The following error codes may be set in
 117 .Va errno :
 118 .Bl -tag -width Er
 119 .It Bq Er EFAULT
 120 An argument address referenced invalid memory.
 121 .It Bq Er EPERM
 122 A user other than the super-user attempted to set the time.
 123 .El
 124 .Sh SEE ALSO
 125 .Xr date 1 ,
 126 .Xr adjtime 2 ,
 127 .Xr ctime 3 ,
 128 .Xr clocks 7
 129 .Sh HISTORY
 130 The
 131 .Fn gettimeofday
 132 function call appeared in
 133 .Bx 4.2 .