.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "Calendar::Simple 3"
.TH Calendar::Simple 3 "2022-02-23" "perl v5.26.3" "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"
Calendar::Simple \- Perl extension to create simple calendars
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Calendar::Simple;
\&
\&  my @curr      = calendar;             # get current month
\&  my @this_sept = calendar(9);          # get 9th month of current year
\&  my @sept_2002 = calendar(9, 2002);    # get 9th month of 2002
\&  my @monday    = calendar(9, 2002, 1); # get 9th month of 2002,
\&                                        # weeks start on Monday
\&
\&  my @span      = date_span(mon   => 10,  # returns span of dates
\&                            year  => 2006,
\&                            begin => 15,
\&                            end   => 28);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A very simple module that exports one function called \f(CW\*(C`calendar\*(C'\fR.
.SS "calendar"
.IX Subsection "calendar"
This function returns a data structure representing the dates in a month.
The data structure returned is an array of array references. The first
level array represents the weeks in the month. The second level array
contains the actual days. By default, each week starts on a Sunday and
the value in the array is the date of that day. Any days at the beginning
of the first week or the end of the last week that are from the previous or
next month have the value \f(CW\*(C`undef\*(C'\fR.
.PP
If the month or year parameters are omitted then the current month or
year are assumed.
.PP
A third, optional parameter, start_day, allows you to set the day each
week starts with, with the same values as localtime sets for wday
(namely, 0 for Sunday, 1 for Monday and so on).
.SS "date_span"
.IX Subsection "date_span"
This function returns a cut-down version of a month data structure which
begins and ends on dates other than the first and last dates of the month.
Any weeks that fall completely outside of the date range are removed from
the structure and any days within the remaining weeks that fall outside
of the date range are set to \f(CW\*(C`undef\*(C'\fR.
.PP
As there are a number of parameters to this function, they are passed
using a named parameter interface. The parameters are as follows:
.IP "year" 4
.IX Item "year"
The required year. Defaults to the current year if omitted.
.IP "mon" 4
.IX Item "mon"
The required month. Defaults to the current month if omitted.
.IP "begin" 4
.IX Item "begin"
The first day of the required span. Defaults to the first if omitted.
.IP "end" 4
.IX Item "end"
The last day of the required span. Defaults to the last day of the month
if omitted.
.IP "start_day" 4
.IX Item "start_day"
Indicates the day of the week that each week starts with. This takes the same
values as the optional third parameter to \f(CW\*(C`calendar\*(C'\fR. The default is 1
(for Monday).
.Sp
\&\fB\s-1NOTE:\s0\fR As of version 2.0.0, the default \f(CW\*(C`start_day\*(C'\fR has changed. Previously,
it was Sunday; now, it is Monday. This is so the default behaviour matches
that of the standard Unix \f(CW\*(C`cal\*(C'\fR command.
.PP
This function isn't exported by default, so in order to use it in your
program you need to use the module like this:
.PP
.Vb 1
\&  use Calendar::Simple \*(Aqdate_span\*(Aq;
.Ve
.SS "\s-1EXAMPLE\s0"
.IX Subsection "EXAMPLE"
A simple \f(CW\*(C`cal\*(C'\fR replacement would therefore look like this:
.PP
.Vb 1
\&  #!/usr/bin/perl
\&
\&  use strict;
\&  use warnings;
\&  use Calendar::Simple;
\&
\&  my @months = qw(January February March April May June July August
\&                  September October November December);
\&
\&  my $mon = shift || (localtime)[4] + 1;
\&  my $yr  = shift || (localtime)[5] + 1900;
\&
\&  my @month = calendar($mon, $yr);
\&
\&  print "\en$months[$mon \-1] $yr\en\en";
\&  print "Su Mo Tu We Th Fr Sa\en";
\&  foreach (@month) {
\&    print map { $_ ? sprintf "%2d ", $_ : \*(Aq   \*(Aq } @$_;
\&    print "\en";
\&  }
.Ve
.PP
A version of this example, called \f(CW\*(C`pcal\*(C'\fR, is installed when you install this
module.
.SS "Date Range"
.IX Subsection "Date Range"
This module will make use of DateTime if it is installed. By using
DateTime it can use any date that \f(CW\*(C`DateTime\*(C'\fR can represent. If DateTime
is not installed it uses Perl's built-in date handling and therefore
can't deal with dates before 1970 and it will also have problems with dates
after 2038 on a 32\-bit machine.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
\&\f(CW\*(C`calendar\*(C'\fR
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Cross <dave@mag\-sol.com>
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
With thanks to Paul Mison <cpan@husk.org> for the start day patch.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2002\-2008, Magnum Solutions Ltd.  All Rights Reserved.
.SH "LICENSE"
.IX Header "LICENSE"
This script 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, localtime, DateTime