{
    "mode": "perldoc",
    "parameter": "Date::Manip::Holidays",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Date%3A%3AManip%3A%3AHolidays/json",
    "generated": "2026-06-16T09:56:46Z",
    "synopsis": "This describes the Holidays and Events sections of the config file, and how they are used.\nHolidays and events are specific days that are named. Holidays are used in business mode\ncalculations, events are not. Events may be used for other calendaring operations.",
    "sections": {
        "NAME": {
            "content": "Date::Manip::Holidays - describes holidays and events\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "This describes the Holidays and Events sections of the config file, and how they are used.\n\nHolidays and events are specific days that are named. Holidays are used in business mode\ncalculations, events are not. Events may be used for other calendaring operations.\n",
            "subsections": []
        },
        "HOLIDAYS": {
            "content": "The holiday section of the config file is used to define holidays. Each line is of the form:\n\nSTRING = HOLIDAY\n\nHOLIDAY is the name of the holiday or it can be blank.\n\nIf HOLIDAY is blank, the holiday is unnamed, but still treated as a holiday. For example, in the\nUS, the day after Thanksgiving is often a work holiday though it is not named.\n\nHOLIDAY should be unique in most cases. The only exception is if the holiday definition is\ncomplex enough that it is impossible to describe it with one STRING. In this case, multiple\nlines may be given with different values of STRING but the same value for HOLIDAY, and in these\ncases, the first STRING that matches a given year will be used. This situation is described in\nmore detail below.\n\nNOTE: It is not allowed to have unnamed holidays that require multiple definitions, so a name\nwill have to be assigned in that case.\n\nSTRING is a string which can be parsed to give a valid date. It can be any of the following\nforms:\n\nA full date\nSpecific holidays can be set which occur only a single time.\n\nMay 5, 2000                     = A one-time-only holiday\n\nAny format parseable by \"Date::Manip::Date::parsedate\" can be used.\n\nThere is one caveat to using a full date. Date::Manip assumes that most holidays will appear\nonce per year, so if you were to explicitly defined New Years (observed) as:\n\n2004-12-31                      = New Year's Day\n\nthen it would assume that it had found the occurrence of New Year's for 2004 when in fact,\nthis is the 2005 occurrence.\n\nFull date specifications should only be used as a last resort, and probably only if you will\nexplicitly specify all occurrence of the holiday.\n\nA date without a year\nSome holidays occur every year on the same day. These can be defined using the simple lines:\n\nJan 1                           = New Year's Day\nJul 4th                         = Independence Day\nfourth Thu in Nov               = Thanksgiving\n\nThese dates must be written in a form which can be parsed as a full date by simply adding\nthe year to the end of the string. Please refer to the Date::Manip::Date documentation to\nsee what forms will work. ISO 8601 dates will not work since the year comes first.\n\nAny format parseable by \"Date::Manip::Date::parsedate\" which allows the year to be at the\nend can be used.\n\nRecurrence\nThe dates can be specified using recurrences:\n\n1*0:0:0:0:0:0*EASTER            = Easter\n1*11:0:11:0:0:0*DWD             = Veteran's Day\n1*11:4:4:0:0:0                  = Thanksgiving\n1*11:4:4:0:0:0*FD1              = Day after Thanksgiving\n\nIn cases where you are interested in business type calculations, you'll want to define most\nholidays using recurrences, since they can define when a holiday is celebrated in the\nfinancial world. For example, Christmas might be defined as:\n\nDec 25               = Christmas\n\nbut if it falls on a weekend, there won't be a business holiday associated with it. It could\nbe defined using a recurrence:\n\n1*12:0:24:0:0:0*DWD  = Christmas\n\nso that if Christmas falls on a weekend, a holiday will be taken on the Friday before or the\nMonday after the weekend.\n\nYou can use the fully specified format of a recurrence:\n\n1*2:0:1:0:0:0*Jan 1 1999*Dec 31 2002 = Feb 2 from 1999-2002\n",
            "subsections": []
        },
        "OTHER HOLIDAY CONSIDERATIONS": {
            "content": "Recurrences which change years\nIt is now valid to have a recurrence defined for New Year's day which pushes the holiday to\nthe previous year.\n\nFor example, the most useful definition of New Year's day is:\n\n1*1:0:1:0:0:0*DWD               = New Year's Day\n\nwhich means to choose the closest working day to observe the holiday, even though this might\nmean that the holiday is observed on the previous year.\n\nOrder of definitions is preserved\nThe order of the definitions is preserved. In other words, when looking at the holidays for\na year, previously defined holidays (in the order given in the config file) are correctly\nhandled.\n\nAs an example, if you wanted to define both Christmas and Boxing days (Boxing is the day\nafter Christmas, and is celebrated in some parts of the world), and you wanted to celebrate\nChristmas on a business day on or after Dec 25, and Boxing day as the following work day,\nyou could do it in one of the following ways:\n\n1*12:0:25:0:0:0*NWD  = Christmas\n1*12:0:26:0:0:0*NWD  = Boxing\n\nor\n\n1*12:0:25:0:0:0*NWD  = Christmas\n1*12:0:25:0:0:0*NWD  = Boxing\n\nHolidays go into affect the minute they are parsed which is why the second example works\n(though for clarity, the first one is preferable). The first recurrence defined the first\nbusiness day on or after Dec 25 as Christmas. The second one then defines the business day\nafter that as Boxing day. Since the definitions are stored as a list (NOT a hash as they\nwere in Date::Manip 5.xx), using the same recurrence twice does not cause a problem.\n\nMultiple holidays\nHaving multiple holidays on a single day is allowed. As an example, you may want to look at\nNew Years day as both the observed and actual holidays, so you might have:\n\n1*1:0:1:0:0:0*DWD               = New Year's Day (observed)\nJan 1                           = New Year's Day\n\nMost of the time, both will fall on the same day, but sometimes they may differ. In this\nexample, it is important that the observed holiday be listed first. Otherwise, Jan 1 will be\nmarked as a holiday and then the observed date will check Jan 1, but where it is not a\nbusiness day, it will move to another day (due to the DWD modifier).\n\nLikewise, the two holidays:\n\n3rd Sunday in June              = Father's Day\nJun 17                          = Bunker Hill Day\n\nsometimes fall on the same day. Using the \"Date::Manip::Date::listholidays\" method (or the\n\"DateIsHoliday\" function), you can get a list of all names that the date contains.\n\nComplex holiday descriptions\nOccasionally, you cannot describe a holiday using a single line. For example, the US Federal\nReserve banks use a complex holiday description where:\n\nFor holidays falling on Saturday, Federal Reserve Banks\nand Branches will be open the preceding Friday. For holidays\nfalling on Sunday, all Federal Reserve Banks and Branches\nwill be closed the following Monday.\n\nSince Saturday is not a business day, the DWD modifier will not work. For these, you need a\nmore complicated definition.\n\nThe following definitions both work:\n\n# Saturday\n1*1:0:1:0:0:0*NBD,BD1,IBD,FD1   = New Year's Day\n# Sunday (observed Monday)\n1*1:0:1:0:0:0*NBD,BD1,NBD,FD2   = New Year's Day\n# M-F\n1*1:0:1:0:0:0*IBD               = New Year's Day\n\nand\n\n# Saturday\n1*1:0:1:0:0:0*IW6               = New Year's Day\n# Sunday (observed Monday)\n1*1:0:1:0:0:0*IW7,FD1           = New Year's Day\n# M-F\n1*1:0:1:0:0:0*IBD               = New Year's Day\n",
            "subsections": []
        },
        "EVENTS": {
            "content": "The Events section of the config file is similar to the Holiday section. It is used to name\ncertain days or times, but there are a few important differences:\n\nEvents can be assigned to any time and duration\nAll holidays are exactly 1 day long. They are assigned to a period of time from midnight to\nmidnight.\n\nEvents can be based at any time of the day, and may be of any duration.\n\nEvents don't affect business mode calculations\nUnlike holidays, events are completely ignored when doing business mode calculations.\n\nWhereas holidays were added with business mode math in mind, events were added with calendar and\nscheduling applications in mind.\n\nEvery line in the events section is of the form:\n\nEVENT = NAME\n\nwhere NAME is the name of the event, and EVENT defines when it occurs and its duration. An EVENT\ncan be defined in the following ways:\n\nDate\nYMD\nYM\nRecur\n\nDate  ; Date\nYMD   ; YMD\nYM    ; YM\nDate  ; Delta\nRecur ; Delta\n\nDate refers to a full date/time (and is any string that can be parsed by\n\"Date::Manip::Date::parse\"). YMD is any string which can be parsed by\n\"Date::Manip::Date::parsedate\". YM is any string which can be parsed by the parsedate method\nto give a date in the current year. Recur is a partial or fully specified recurrence. Delta is\nany string that can be parsed to form a delta.\n\nWith the \"Date\" form, or the \"Recur\" form, the event starts at the time (or times) specified by\nthe date or recurrence, and last 1 hour long. With the \"YMD\" and \"YM\" forms, the event occurs on\nthe given day, and lasts all day.\n\nWith all of the two part forms (\"Date;Date\", \"YM;YM\", etc.), the event starts at the first date\nand goes to the second date, or goes an amount of time specified by the delta.\n\nThe \"YMD;YMD\" and \"YM;YM\" forms means that the event lasts from the start of the first date to\nthe end of the second. In the Date;Date form, the event goes from the first date to the second\ndate inclusive. In other words, both dates are in the event. In the \"Date;Delta\" and\n\"Recur;Delta\" forms, the Delta tells the length of the event. Also, in the Date;Date form, the\nsecond date may NOT be expressed as a delta.\n\nCurrently, having an event longer than 1 year is NOT supported, but no checking is done for\nthis.\n",
            "subsections": []
        },
        "KNOWN BUGS": {
            "content": "None known.\n",
            "subsections": []
        },
        "BUGS AND QUESTIONS": {
            "content": "Please refer to the Date::Manip::Problems documentation for information on submitting bug\nreports or questions to the author.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "Date::Manip - main module documentation\n",
            "subsections": []
        },
        "LICENSE": {
            "content": "This script is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Sullivan Beck (sbeck@cpan.org)\n",
            "subsections": []
        }
    },
    "summary": "Date::Manip::Holidays - describes holidays and events",
    "flags": [],
    "examples": [],
    "see_also": []
}