lib/libc/time/offtime.3

   1 .\"     $NetBSD$
   2 .\" Written by Klaus Klein, May 10, 2004.
   3 .\" Public domain.
   4 .Dd May 10, 2004
   5 .Dt OFFTIME 3
   6 .Os
   7 .Sh NAME
   8 .Nm offtime ,
   9 .Nm timeoff ,
  10 .Nm timegm ,
  11 .Nm timelocal
  12 .Nd convert date and time
  13 .Sh LIBRARY
  14 .Lb libc
  15 .Sh SYNOPSIS
  16 .In time.h
  17 .Ft struct tm *
  18 .Fn offtime "const time_t * clock" "long int offset"
  19 .Ft time_t
  20 .Fn timeoff "struct tm * tm" "long int offset"
  21 .Ft time_t
  22 .Fn timegm "struct tm * tm"
  23 .Ft time_t
  24 .Fn timelocal "struct tm * tm"
  25 .Sh DESCRIPTION
  26 These functions are inspired by C standard interfaces named similarly.
  27 .Pp
  28 .Fn offtime
  29 converts the calendar time
  30 .Fa clock ,
  31 offset by
  32 .Fa offset
  33 seconds,
  34 into broken-down time, expressed as Coordinated Universal Time (UTC).
  35 .Pp
  36 .Fn timeoff
  37 converts the broken-down time
  38 .Fa tm ,
  39 expressed as UTC,
  40 offset by
  41 .Fa offset
  42 seconds,
  43 into a calendar time value.
  44 .Pp
  45 .Fn timegm
  46 converts the broken-down time
  47 .Fa tm
  48 into a calendar time value, effectively being the inverse of
  49 .Xr gmtime 3 .
  50 It is equivalent to the C standard function
  51 .Xr mktime 3
  52 operating in UTC.
  53 .Pp
  54 .Fn timelocal
  55 converts the broken down time
  56 .Fa tm ,
  57 expressed as local time, into a calendar time value.
  58 It is equivalent to the C standard function
  59 .Xr mktime 3 ,
  60 and is provided for symmetry only.
  61 .Sh SEE ALSO
  62 .Xr ctime 3 ,
  63 .Xr tzset 3