[BACK]Return to offtime.3 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / lib / libc / time

File: [cvs.NetBSD.org] / src / lib / libc / time / offtime.3 (download)

Revision 1.4, Wed Oct 25 19:01:25 2017 UTC (3 years, 1 month ago) by abhinav
Branch: MAIN
CVS Tags: phil-wifi-base, phil-wifi-20200421, phil-wifi-20200411, phil-wifi-20200406, phil-wifi-20191119, phil-wifi-20190609, phil-wifi, pgoyette-compat-merge-20190127, pgoyette-compat-base, pgoyette-compat-20190127, pgoyette-compat-20190118, pgoyette-compat-1226, pgoyette-compat-1126, pgoyette-compat-1020, pgoyette-compat-0930, pgoyette-compat-0906, pgoyette-compat-0728, pgoyette-compat-0625, pgoyette-compat-0521, pgoyette-compat-0502, pgoyette-compat-0422, pgoyette-compat-0415, pgoyette-compat-0407, pgoyette-compat-0330, pgoyette-compat-0322, pgoyette-compat-0315, pgoyette-compat, netbsd-9-base, netbsd-9-1-RELEASE, netbsd-9-0-RELEASE, netbsd-9-0-RC2, netbsd-9-0-RC1, netbsd-9, is-mlppp-base, is-mlppp, HEAD
Changes since 1.3: +2 -1 lines

Add offtime_r to the NAME section

.\"	$NetBSD: offtime.3,v 1.4 2017/10/25 19:01:25 abhinav Exp $
.\" Written by Klaus Klein, May 10, 2004.
.\" Public domain.
.Dd April 14, 2011
.Dt OFFTIME 3
.Os
.Sh NAME
.Nm offtime ,
.Nm offtime_r ,
.Nm timeoff ,
.Nm timegm ,
.Nm timelocal
.Nd convert date and time
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In time.h
.Ft struct tm *
.Fn offtime "const time_t * clock" "long int offset"
.Ft struct tm *
.Fn offtime_r "const time_t * clock" "long int offset" "struct tm *ret"
.Ft time_t
.Fn timeoff "struct tm * tm" "long int offset"
.Ft time_t
.Fn timegm "struct tm * tm"
.Ft time_t
.Fn timelocal "struct tm * tm"
.Sh DESCRIPTION
These functions are inspired by C standard interfaces named similarly.
.Pp
.Fn offtime
converts the calendar time
.Fa clock ,
offset by
.Fa offset
seconds,
into broken-down time, expressed as Coordinated Universal Time (UTC).
.Pp
.Fn offtime_r
is similar to
.Fn offtime
but it places the returned
.Ft "struct tm *"
in the user supplied
.Fa ret
argument.
.Pp
.Fn timeoff
converts the broken-down time
.Fa tm ,
expressed as UTC,
offset by
.Fa offset
seconds,
into a calendar time value.
.Pp
.Fn timegm
converts the broken-down time
.Fa tm
into a calendar time value, effectively being the inverse of
.Xr gmtime 3 .
It is equivalent to the C standard function
.Xr mktime 3
operating in UTC.
.Pp
.Fn timelocal
converts the broken down time
.Fa tm ,
expressed as local time, into a calendar time value.
It is equivalent to the C standard function
.Xr mktime 3 ,
and is provided for symmetry only.
.Sh SEE ALSO
.Xr ctime 3 ,
.Xr tm 3 ,
.Xr tzset 3