.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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 "Tie::iCal 3pm"
.TH Tie::iCal 3pm "2015-05-29" "perl v5.20.2" "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"
Tie::iCal \- Tie iCal files to Perl hashes.
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.14 released 1st September 2006.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Tie::iCal;
\&        
\&        tie %my_events, \*(AqTie::iCal\*(Aq, "mycalendar.ics" or die "Failed to tie file!\en";
\&        tie %your_events, \*(AqTie::iCal\*(Aq, "yourcalendar.ics" or die "Failed to tie file!\en";
\&        
\&        $my_events{"A\-NEW\-UNIQUE\-ID"} = [
\&                \*(AqVEVENT\*(Aq,
\&                {
\&                        \*(AqSUMMARY\*(Aq => \*(AqBastille Day Party\*(Aq,
\&                        \*(AqDTSTAMP\*(Aq => \*(Aq19970714T170000Z\*(Aq,
\&                        \*(AqDTEND\*(Aq => \*(Aq19970715T035959Z\*(Aq,
\&                }
\&        ];
\&        
\&        tie %our_events, \*(AqTie::iCal\*(Aq, "ourcalendar.ics" or die "Failed to tie file!\en";
\&        
\&        # assuming %my_events and %your_events
\&        # have no common keys (unless that\*(Aqs your intention)
\&        #
\&        while (my($uid,$event) = each(%my_events)) {
\&                $our_events{$uid} = $event;     
\&        }
\&        while (my($uid,$event) = each(%your_events)) {
\&                $our_events{$uid} = $event;
\&        }
\&        
\&        untie %our_events;
\&        untie %your_events;
\&        untie %my_events;
.Ve
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
.Vb 1
\&        Tie::File
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Tie::iCal represents an \s-1RFC2445\s0 iCalendar file as a Perl hash. Each key in the hash represents
an iCalendar component like \s-1VEVENT, VTODO\s0 or \s-1VJOURNAL.\s0 Each component in the file must have
a unique \s-1UID\s0 property as specified in the \s-1RFC 2445. A\s0 file containing non-unique UIDs can
be converted to have only unique UIDs (see samples/uniquify.pl).
.PP
The module makes very little effort in understanding what each iCalendar property means and concentrates
on the format of the iCalendar file only.
.SH "FILE LOCKING"
.IX Header "FILE LOCKING"
The Tie::iCal object returned by tie can also be used to access the underlying Tie::File object.
This is accessible via the 'A' class variable.
This may be useful for file locking.
.PP
.Vb 2
\&        my $ical = tie %events, \*(AqTie::iCal\*(Aq, "mycalendar.ics";
\&        $ical\->{A}\->flock;
.Ve
.SH "DATES"
.IX Header "DATES"
The iCalendar specification uses a special format for dates. This module makes no effort in trying
to interpret dates in this format. You should look at the Date::ICal module that can convert between
Unix epoch dates and iCalendar date strings.
.SH "How Tie::iCal interprets iCal files"
.IX Header "How Tie::iCal interprets iCal files"
Tie::iCal interprets files by mapping iCal components into Perl hash keys and
iCal content lines into various Perl arrays and hashes.
.SS "Components"
.IX Subsection "Components"
An iCal component such as \s-1VEVENT, VTODO\s0 or \s-1VJOURNAL\s0 maps to a hash key:\-
.PP
.Vb 5
\&        BEGIN:VEVENT
\&        UID:a_unique_uid
\&        NAME1:VALUE1
\&        ..
\&        END:VEVENT
.Ve
.PP
corresponds to
.PP
.Vb 1
\&        $events{\*(Aqa_unique_uid\*(Aq} = [\*(AqVEVENT\*(Aq, {\*(AqNAME1\*(Aq => \*(AqVALUE1\*(Aq}]
.Ve
.SS "Subcomponents"
.IX Subsection "Subcomponents"
An iCal subcomponent such as \s-1VALARM\s0 maps to a list of hash keys:\-
.PP
.Vb 9
\&        BEGIN:VALARM
\&        TRIGGER;VALUE=DURATION:\-PT1S
\&        TRIGGER;VALUE=DURATION:\-PT1S
\&        END:VALARM
\&        BEGIN:VALARM
\&        X\-TIE\-ICAL;VALUE=ANOTHER:HERE
\&        X\-TIE\-ICAL:HERE2
\&        X\-TIE\-ICAL\-NAME:HERE2
\&        END:VALARM
.Ve
.PP
corresponds to
.PP
.Vb 10
\&        \*(AqVALARM\*(Aq => [
\&                {
\&                        \*(AqTRIGGER\*(Aq => [
\&                                [{\*(AqVALUE\*(Aq => \*(AqDURATION\*(Aq},\*(Aq\-PT1S\*(Aq],
\&                                [{\*(AqVALUE\*(Aq => \*(AqDURATION\*(Aq},\*(Aq\-PT1S\*(Aq]
\&                        ]
\&                },
\&                {
\&                        \*(AqX\-TIE\-ICAL\*(Aq => [
\&                                [{\*(AqVALUE\*(Aq => \*(AqANOTHER\*(Aq},\*(AqHERE\*(Aq],
\&                                [\*(AqHERE2\*(Aq]
\&                        ],
\&                        \*(AqX\-TIE\-ICAL\-NAME\*(Aq => \*(AqHERE2\*(Aq
\&                }
\&        ]
.Ve
.PP
To see how individual content lines are formed see below.
.SS "Content Lines"
.IX Subsection "Content Lines"
Once unfolded, a content line may look like:\-
.PP
.Vb 1
\&    NAME;PARAM1=PVAL1;PARAM2=PVAL2;...:VALUE1,VALUE2,...
.Ve
.PP
having an equivalent perl data structure like: \-
.PP
.Vb 1
\&    \*(AqNAME\*(Aq => [{\*(AqPARAM1\*(Aq=>\*(AqPVAL1\*(Aq, \*(AqPARAM2\*(Aq=>\*(AqPVAL2\*(Aq, ..}, \*(AqVALUE1\*(Aq, \*(AqVALUE2\*(Aq, ..]
.Ve
.PP
or
.PP
.Vb 1
\&    NAME:VALUE1,VALUE2,...
.Ve
.PP
having an equivalent perl data structure like: \-
.PP
.Vb 1
\&    \*(AqNAME\*(Aq => [\*(AqVALUE1\*(Aq, \*(AqVALUE2\*(Aq, ..]
.Ve
.PP
or
.PP
.Vb 1
\&    NAME:VALUE
.Ve
.PP
having an equivalent perl data structure like: \-
.PP
.Vb 1
\&    \*(AqNAME\*(Aq => \*(AqVALUE\*(Aq
.Ve
.PP
An blank value is mapped from
.PP
.Vb 1
\&        NAME:
.Ve
.PP
to
.PP
.Vb 1
\&        \*(AqNAME\*(Aq => \*(Aq\*(Aq
.Ve
.PP
Multiple contentlines with same name, i.e. \s-1FREEBUSY, ATTENDEE:\-\s0
.PP
.Vb 3
\&    NAME;PARAM10=PVAL10;PARAM20=PVAL20;...:VALUE10,VALUE20,...
\&    NAME;PARAM11=PVAL11;PARAM21=PVAL21;...:VALUE11,VALUE21,...
\&    ...
.Ve
.PP
having an equivalent perl data structure like: \-
.PP
.Vb 5
\&    \*(AqNAME\*(Aq => [ 
\&        [{\*(AqPARAM10\*(Aq=>\*(AqPVAL10\*(Aq, \*(AqPARAM20\*(Aq=>\*(AqPVAL20\*(Aq, ..}, \*(AqVALUE10\*(Aq, \*(AqVALUE20\*(Aq, ..],
\&        [{\*(AqPARAM11\*(Aq=>\*(AqPVAL11\*(Aq, \*(AqPARAM21\*(Aq=>\*(AqPVAL21\*(Aq, ..}, \*(AqVALUE11\*(Aq, \*(AqVALUE21\*(Aq, ..],
\&        ...
\&    ]
.Ve
.PP
or
.PP
.Vb 3
\&    NAME:VALUE10,VALUE20,...
\&    NAME:VALUE11,VALUE21,...
\&    ...
.Ve
.PP
having an equivalent perl data structure like: \-
.PP
.Vb 5
\&    \*(AqNAME\*(Aq => [ 
\&        [\*(AqVALUE10\*(Aq, \*(AqVALUE20\*(Aq, ..],
\&        [\*(AqVALUE11\*(Aq, \*(AqVALUE21\*(Aq, ..],
\&        ...
\&    ]
.Ve
.PP
or in a mixed form, i.e.
.PP
.Vb 4
\&    NAME:VALUE10,VALUE20,...
\&    NAME;PARAM11=PVAL11;PARAM21=PVAL21:VALUE11,VALUE21,...
\&    NAME:VALUE12,VALUE22,...
\&    ...
.Ve
.PP
having an equivalent perl data structure like: \-
.PP
.Vb 6
\&    \*(AqNAME\*(Aq => [ 
\&        [\*(AqVALUE10\*(Aq, \*(AqVALUE20\*(Aq, ..],
\&        [{\*(AqPARAM11\*(Aq=>\*(AqPVAL11\*(Aq, \*(AqPARAM21\*(Aq=>\*(AqPVAL21\*(Aq, ..}, \*(AqVALUE11\*(Aq, \*(AqVALUE21\*(Aq, ..],
\&        [\*(AqVALUE12\*(Aq, \*(AqVALUE22\*(Aq, ..],
\&        ...
\&    ]
.Ve
.SH "BUGS"
.IX Header "BUGS"
Property names are assumed not to be folded, i.e.
.PP
.Vb 2
\&        DESCR
\&         IPTION:blah blah..
.Ve
.PP
\&\s-1RRULE\s0 property does not support parameters.
.PP
Property names that begin with \s-1UID\s0 can potentially confuse this module.
.PP
Subcomponents such as \s-1VALARM\s0 must exist after any \s-1UID\s0 property.
.PP
Deleting events individually may leave non\-RFC2445 compliant empty \s-1VCALENDAR\s0 objects.
.SH "AUTHOR"
.IX Header "AUTHOR"
Blair Sutton, <mailto:bsdz@cpan.org>, <http://www.numeninest.com/>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2006 Blair Sutton. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl, Tie::File, Date::ICal