.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DateTime::Format::DateManip 3pm"
.TH DateTime::Format::DateManip 3pm "2022-08-16" "perl v5.34.0" "User Contributed Perl 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"
DateTime::Format::DateManip \- Perl DateTime extension to convert
Date::Manip dates and durations to DateTimes and vice versa.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Date::Manip;
\&  use DateTime::Format::DateManip;
\&
\&  # Date::Manip to DateTime
\&  my $dm = ParseDate("January 1st, 2001");
\&  my $dt = DateTime::Format::DateManip\->parse_datetime($dm);
\&
\&  $dt\->add( weeks => 1 );  
\&
\&  # And back again
\&  my $dm2 = DateTime::Format::DateManip\->format_datetime($dt);
\&
\&  # Same thing with a duration
\&  my $dm_delta  = ParseDateDelta("3 years 2 days \-4 hours +3mn \-2 second");
\&  my $dt_dur    = DateTime::Format::DateManip\->parse_duration($dm_delta);
\&  my $dm_delta2 = DateTime::Format::DateManip\->format_duration($dt_dur);
\&
\&  # Note that we can parse any string that is in the appropriate format
\&  # there is no need to call ParseDate or ParseDateDelta first:
\&  my $dt2     = DateTime::Format::DateManip\->parse_datetime("In 2 hours");
\&  my $dt_dur2 = DateTime::Format::DateManip\->parse_duration("3 years");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
DateTime::Format::DateManip is a class that knows how to convert
between \f(CW\*(C`Date::Manip\*(C'\fR dates and durations and \f(CW\*(C`DateTime\*(C'\fR and
\&\f(CW\*(C`DateTime::Duration\*(C'\fR objects.  Recurrences are note yet supported.
.SH "USAGE"
.IX Header "USAGE"
.SS "Time Zones"
.IX Subsection "Time Zones"
\&\f(CW\*(C`Date::Manip\*(C'\fR can have a time zone set globally and it keeps the
dates it produces in the local time.  In all cases we rely on the \s-1GMT\s0
offset to set up the \f(CW\*(C`DateTime\*(C'\fR object.  However, we try to work out
what the matching timezone is using the \f(CW\*(C`DateTime\*(C'\fR nomenclature and
create the object in the correct time zone so the date is correct if
dajustments to the date object pushes it over a \s-1DST\s0 change.  Note that
we call \f(CW\*(C`set_time_zone\*(C'\fR to make the change, so the absolute time is
not affected by the time zone change.
.PP
However, not all \f(CW\*(C`Date::Manip\*(C'\fR time zones have reasonable mappings
(for example \s-1NT\s0 and \s-1CAT\s0 both appear to be obsolete).  It is unlikely
that a user will have their time zone set to one of these items.  If
we are unable to work out the mapping we simply use the \s-1GMT\s0 offset and
do not set a timezone.
.PP
When converting to a \f(CW\*(C`Date::Manip\*(C'\fR we only need to tell
\&\f(CW\*(C`Date::Manip\*(C'\fR the \s-1GMT\s0 offset and it will automatically convert to the
local time zone that is in effect.
.SS "Class Methods"
.IX Subsection "Class Methods"
.IP "\(bu" 4
parse_datetime( \f(CW$date_manip_string\fR )
.Sp
This method takes the input string and returns the corresponding
\&\f(CW\*(C`DateTime\*(C'\fR object.  If \f(CW\*(C`Date::Manip::ParseDate\*(C'\fR was unable to parse
the input string then undef will be returned.  See the note above
about Time Zones.
.IP "\(bu" 4
format_datetime( \f(CW$datetime_object\fR )
.Sp
This method takes the given \f(CW\*(C`DateTime\*(C'\fR object and returns a
corresponding \f(CW\*(C`Date::Manip::ParseDate\*(C'\fR parseable string.  See the
note above about Time Zones.
.IP "\(bu" 4
parse_duration( \f(CW$date_manip_duration_string\fR )
.Sp
This method takes the giben duration string and returns the
corresponding \f(CW\*(C`DateTime::Duration\*(C'\fR object.  If
\&\f(CW\*(C`Date::Manip::ParseDateDelta\*(C'\fR was unable to parse the input string
then undef will be returned.
.IP "\(bu" 4
format_duration( \f(CW$datetime_duration_object\fR )
.Sp
This method takes the given \f(CW\*(C`DateTime::Duration\*(C'\fR object and returns a
corresponding \f(CW\*(C`Date::Manip::ParseDateDelta\*(C'\fR parseable string.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ben Bennett <fiji at limey dot net>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003 Ben Bennett.  All rights reserved.  This program
is free software; you can redistribute it and/or modify it under the
same terms as Perl itself.
.PP
Portions of the code in this distribution are derived from other
works.  Please see the \s-1CREDITS\s0 file for more details.
.PP
The full text of the license can be found in the \s-1LICENSE\s0 file included
with this module.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
datetime@perl.org mailing list
.PP
http://datetime.perl.org/