[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.1, Mon May 10 02:02:00 2004 UTC (16 years, 4 months ago) by kleink
Branch: MAIN
CVS Tags: yamt-pf42-baseX, yamt-pf42-base4, yamt-pf42-base3, yamt-pf42-base2, yamt-pf42-base, yamt-pf42, wrstuden-revivesa-base-3, wrstuden-revivesa-base-2, wrstuden-revivesa-base-1, wrstuden-revivesa-base, wrstuden-revivesa, wrstuden-fixsa-newbase, wrstuden-fixsa-base-1, wrstuden-fixsa-base, wrstuden-fixsa, netbsd-5-base, netbsd-5-2-RELEASE, netbsd-5-2-RC1, netbsd-5-2-3-RELEASE, netbsd-5-2-2-RELEASE, netbsd-5-2-1-RELEASE, netbsd-5-2, netbsd-5-1-RELEASE, netbsd-5-1-RC4, netbsd-5-1-RC3, netbsd-5-1-RC2, netbsd-5-1-RC1, netbsd-5-1-5-RELEASE, netbsd-5-1-4-RELEASE, netbsd-5-1-3-RELEASE, netbsd-5-1-2-RELEASE, netbsd-5-1-1-RELEASE, netbsd-5-1, netbsd-5-0-RELEASE, netbsd-5-0-RC4, netbsd-5-0-RC3, netbsd-5-0-RC2, netbsd-5-0-RC1, netbsd-5-0-2-RELEASE, netbsd-5-0-1-RELEASE, netbsd-5-0, netbsd-5, netbsd-4-base, netbsd-4-0-RELEASE, netbsd-4-0-RC5, netbsd-4-0-RC4, netbsd-4-0-RC3, netbsd-4-0-RC2, netbsd-4-0-RC1, netbsd-4-0-1-RELEASE, netbsd-4-0, netbsd-4, netbsd-3-base, netbsd-3-1-RELEASE, netbsd-3-1-RC4, netbsd-3-1-RC3, netbsd-3-1-RC2, netbsd-3-1-RC1, netbsd-3-1-1-RELEASE, netbsd-3-1, netbsd-3-0-RELEASE, netbsd-3-0-RC6, netbsd-3-0-RC5, netbsd-3-0-RC4, netbsd-3-0-RC3, netbsd-3-0-RC2, netbsd-3-0-RC1, netbsd-3-0-3-RELEASE, netbsd-3-0-2-RELEASE, netbsd-3-0-1-RELEASE, netbsd-3-0, netbsd-3, mjf-devfs2-base, mjf-devfs2, matt-premerge-20091211, matt-nb5-pq3-base, matt-nb5-pq3, matt-nb5-mips64-u2-k2-k4-k7-k8-k9, matt-nb5-mips64-u1-k1-k5, matt-nb5-mips64-premerge-20101231, matt-nb5-mips64-premerge-20091211, matt-nb5-mips64-k15, matt-nb5-mips64, matt-nb4-mips64-k7-u2a-k9b, matt-mips64-base2, matt-mips64-base, matt-mips64, matt-armv6-prevmlocking, matt-armv6-nbase, matt-armv6-base, matt-armv6, keiichi-mipv6-base, keiichi-mipv6, jym-xensuspend-nbase, jym-xensuspend-base, jym-xensuspend, hpcarm-cleanup-nbase, hpcarm-cleanup-base, hpcarm-cleanup, cube-autoconf-base, cube-autoconf, christos-time_t-nbase, christos-time_t-base, christos-time_t, abandoned-netbsd-4-base, abandoned-netbsd-4

Add a manual page for the standard-inspired offtime(3) and friends;
requested by Thomas Klausner.

.\"	$NetBSD: offtime.3,v 1.1 2004/05/10 02:02:00 kleink Exp $
.\" Written by Klaus Klein, May 10, 2004.
.\" Public domain.
.Dd May 10, 2004
.Dt OFFTIME 3
.Os
.Sh NAME
.Nm offtime ,
.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 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 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 tzset 3