lib/libc/time/offtime.3

   1 .\"     $NetBSD: offtime.3,v 1.3 2011/04/14 05:50:50 jruoho Exp $
   2 .\" Written by Klaus Klein, May 10, 2004.
   3 .\" Public domain.
   4 .Dd April 14, 2011
   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 struct tm *
  20 .Fn offtime_r "const time_t * clock" "long int offset" "struct tm *ret"
  21 .Ft time_t
  22 .Fn timeoff "struct tm * tm" "long int offset"
  23 .Ft time_t
  24 .Fn timegm "struct tm * tm"
  25 .Ft time_t
  26 .Fn timelocal "struct tm * tm"
  27 .Sh DESCRIPTION
  28 These functions are inspired by C standard interfaces named similarly.
  29 .Pp
  30 .Fn offtime
  31 converts the calendar time
  32 .Fa clock ,
  33 offset by
  34 .Fa offset
  35 seconds,
  36 into broken-down time, expressed as Coordinated Universal Time (UTC).
  37 .Pp
  38 .Fn offtime_r
  39 is similar to
  40 .Fn offtime
  41 but it places the returned
  42 .Ft "struct tm *"
  43 in the user supplied
  44 .Fa ret
  45 argument.
  46 .Pp
  47 .Fn timeoff
  48 converts the broken-down time
  49 .Fa tm ,
  50 expressed as UTC,
  51 offset by
  52 .Fa offset
  53 seconds,
  54 into a calendar time value.
  55 .Pp
  56 .Fn timegm
  57 converts the broken-down time
  58 .Fa tm
  59 into a calendar time value, effectively being the inverse of
  60 .Xr gmtime 3 .
  61 It is equivalent to the C standard function
  62 .Xr mktime 3
  63 operating in UTC.
  64 .Pp
  65 .Fn timelocal
  66 converts the broken down time
  67 .Fa tm ,
  68 expressed as local time, into a calendar time value.
  69 It is equivalent to the C standard function
  70 .Xr mktime 3 ,
  71 and is provided for symmetry only.
  72 .Sh SEE ALSO
  73 .Xr ctime 3 ,
  74 .Xr tm 3 ,
  75 .Xr tzset 3