Blame man3/timegm.3

Packit 7cfc04
.\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.TH TIMEGM 3 2016-12-12 "GNU" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
timegm, timelocal \- inverses of gmtime and localtime
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <time.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "time_t timelocal(struct tm *" tm );
Packit 7cfc04
.PP
Packit 7cfc04
.BI "time_t timegm(struct tm *" tm );
Packit 7cfc04
.PP
Packit 7cfc04
.fi
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.BR timelocal (),
Packit 7cfc04
.BR timegm ():
Packit 7cfc04
    Since glibc 2.19:
Packit 7cfc04
        _DEFAULT_SOURCE
Packit 7cfc04
    Glibc 2.19 and earlier:
Packit 7cfc04
        _BSD_SOURCE || _SVID_SOURCE
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The functions
Packit 7cfc04
.BR timelocal ()
Packit 7cfc04
and
Packit 7cfc04
.BR timegm ()
Packit 7cfc04
are the inverses of
Packit 7cfc04
.BR localtime (3)
Packit 7cfc04
and
Packit 7cfc04
.BR gmtime (3).
Packit 7cfc04
Both functions take a broken-down time and convert it to calendar time
Packit 7cfc04
(seconds since the Epoch, 1970-01-01 00:00:00 +0000, UTC).
Packit 7cfc04
The difference between the two functions is that
Packit 7cfc04
.BR timelocal ()
Packit 7cfc04
takes the local timezone into account when doing the conversion, while
Packit 7cfc04
.BR timegm ()
Packit 7cfc04
takes the input value to be Coordinated Universal Time (UTC).
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
On success,
Packit 7cfc04
these functions return the calendar time (seconds since the Epoch),
Packit 7cfc04
expressed as a value of type
Packit 7cfc04
.IR time_t .
Packit 7cfc04
On error, they return the value
Packit 7cfc04
.IR "(time_t)\ -1"
Packit 7cfc04
and set
Packit 7cfc04
.I errno
Packit 7cfc04
to indicate the cause of the error.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
.TP
Packit 7cfc04
.B EOVERFLOW
Packit 7cfc04
The result cannot be represented.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lbw21 lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR timelocal (),
Packit 7cfc04
.BR timegm ()
Packit 7cfc04
T}	Thread safety	MT-Safe env locale
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
These functions are nonstandard GNU extensions
Packit 7cfc04
that are also present on the BSDs.
Packit 7cfc04
Avoid their use.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
The
Packit 7cfc04
.BR timelocal ()
Packit 7cfc04
function is equivalent to the POSIX standard function
Packit 7cfc04
.BR mktime (3).
Packit 7cfc04
There is no reason to ever use it.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR gmtime (3),
Packit 7cfc04
.BR localtime (3),
Packit 7cfc04
.BR mktime (3),
Packit 7cfc04
.BR tzset (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.