.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Time 3pm"
.TH Time 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lire::Time \- parses and prints date in formats common to many log files.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Lire::Time qw/ syslog2cal /;
\&
\&    my @ltime = localtime;
\&
\&    while ( <LOGFILE> ) {
\&        #...
\&        my $time = syslog2cal( $m, $d, $t, \e@ltime );
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module supplies many functions to parse dates in formats that you
are likely to encounter in log files. It also offers many functions to format
epoch time in useful format.
.SS "NOTE ABOUT FUNCTION EXPORT"
.IX Subsection "NOTE ABOUT FUNCTION EXPORT"
Altough all documented functions are exported by default to the caller
namespace, you should explicitely import the functions you require
since exporting by default isn\*(Aqt recommanded by the perl modules
guidelines.
.SH "DATE PARSING FUNCTIONS"
.IX Header "DATE PARSING FUNCTIONS"
This module includes several functions that convert between a more
human readable date format and UNIX epoch time. All parsing functions
will return the number of seconds since Jan 1 1970 00:00:00 UTC and
will \fBdie()\fR when passed invalid arguments.
.SS \fBdate2cal()\fP
.IX Subsection "date2cal()"
.Vb 2
\&    my $time = date2cal( $year, $month, $day, $time, [$timezone] );
\&    my $time = date2cal( "2001 Mar 20 09:32:29 +0100" );
.Ve
.PP
This function will convert a date in the \fBdate\fR\|(1) default output format
to UNIX epoch time. The function accepts either the date in a string
or splitted on whitespace. If the timezone component is omitted, the
local timezone is assumed (usually based on the value of the TZ
environment variable).
.SS \fBsyslog2cal()\fP
.IX Subsection "syslog2cal()"
.Vb 2
\&    my $time = syslog2cal( $month, $day, $time, $local_tm_ref );
\&    my $time = syslog2cal( "Mar 11 13:21:00", $local_tm_ref );
.Ve
.PP
This function will convert a date in the syslog default output format
to UNIX epoch time. The function accepts either the date in a string
or splitted on whitespace.
.PP
Since the syslog format doesn\*(Aqt contain timezone information, the
local timezone is assumed (usually determined by the TZ environment
variable).
.PP
The last argument is a reference to an array returned by \fBlocaltime()\fR.
.PP
.Vb 1
\&    my $local_tm_ref = [localtime()];
.Ve
.PP
It is used to determine the year.
.SS \fBclf2cal()\fP
.IX Subsection "clf2cal()"
.Vb 1
\&    my $time = clf2cal( "[18/Mar/2001:15:59:30 +0100]" );
.Ve
.PP
This function will convert a date as found in Common Log Format to
UNIX epoch time.
.SH "DATE FORMATING FUNCTIONS"
.IX Header "DATE FORMATING FUNCTIONS"
This module includes some functions to convert date in UNIX epoch time to
some more human readable output. All functions will \fBdie()\fR when passed
invalid arguments.
.SS \fBcal2rfc()\fP
.IX Subsection "cal2rfc()"
.Vb 1
\&    print cal2rfc( $time );
.Ve
.PP
This function will convert a date in UNIX epoch time to the RFC822 format
(used in email, for example). A RFC822 date looks like
.PP
.Vb 1
\&    Wed, 30 May 2001 12:45:13 +0000
.Ve
.PP
The timezone offset specification will correspond to the local
timezone (usually determined by the TZ environment variable).
.SS \fBcal2ymdhms()\fP
.IX Subsection "cal2ymdhms()"
.Vb 1
\&    print cal2ymdhms( $time );
.Ve
.PP
This function converts a date in UNIX epoch time to a string of the form:
.PP
.Vb 1
\&    YYYYMMDDHHMMSS
.Ve
.PP
This representation will correspond the time in the local timezone (usually determined by the TZ environment variable.)
.SS \fBgetMonthName()\fP
.IX Subsection "getMonthName()"
.Vb 1
\&    print getMonthName( 0 ); # Gives \*(AqJan\*(Aq
.Ve
.PP
This function takes as parameter a number (0\-11) representing the
month (as returned by \fBlocaltime()\fR for example) and will return the
English abbreviated name of that month ( Jan, Feb, etc. ).
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Joost van Baal <joostvb@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Time.pm,v 1.10 2006/07/23 13:16:30 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2000\-2002 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.