lib/libcalendar/calendar.3

   1 .\" Copyright (c) 1997 Wolfgang Helbig
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd November 29, 1997
  28 .Dt CALENDAR 3
  29 .Os
  30 .Sh NAME
  31 .Nm easterg ,
  32 .Nm easterog ,
  33 .Nm easteroj ,
  34 .Nm gdate ,
  35 .Nm jdate ,
  36 .Nm ndaysg ,
  37 .Nm ndaysj ,
  38 .Nm week ,
  39 .Nm weekday
  40 .Nd Calendar arithmetic for the Christian era.
  41 .Sh SYNOPSIS
  42 .Fd #include <calendar.h>
  43 .Ft struct date *
  44 .Fn easterg "int year" "struct date *dt"
  45 .Ft struct date *
  46 .Fn easterog "int year" "struct date *dt"
  47 .Ft struct date *
  48 .Fn easteroj "int year" "struct date *dt"
  49 .Ft struct date *
  50 .Fn gdate "int nd" "struct date *dt"
  51 .Ft struct date *
  52 .Fn jdate "int nd" "struct date *dt"
  53 .Ft int
  54 .Fn ndaysg "struct date *dt"
  55 .Ft int
  56 .Fn ndaysj "struct date *dt"
  57 .Ft int
  58 .Fn week "int nd" "int *year"
  59 .Ft int
  60 .Fn weekday "int nd"
  61 .Sh DESCRIPTION
  62 These functions provide calendar arithmetic for a large range of years,
  63 starting at March 1st, year zero (i. e. 1 B.C.) and ending way beyond
  64 year 100000.
  65 .Pp
  66 Programs should be linked with
  67 .Fl lcalendar .
  68 .Pp
  69 The functions
  70 .Fn easterg ,
  71 .Fn easterog
  72 and
  73 .Fn easteroj
  74 store the date of Easter Sunday into the structure pointed at by
  75 .Fa dt
  76 and return a pointer to this structure.
  77 The function
  78 .Fn easterg
  79 assumes Gregorian Calendar (adopted by most western churches after 1582) and
  80 the functions
  81 .Fn easterog
  82 and
  83 .Fn easteroj
  84 compute the date of Easter Sunday according to the orthodox rules
  85 (Western churches before 1582, Greek and Russian Orthodox Church
  86 until today).
  87 The result returned by
  88 .Fn easterog
  89 is the date in Gregorian Calendar, whereas
  90 .Fn easteroj
  91 returns the date in Julian Calendar.
  92 .Pp
  93 The functions
  94 .Fn gdate ,
  95 .Fn jdate ,
  96 .Fn ndaysg
  97 and
  98 .Fn ndaysj
  99 provide conversions between the common "year, month, day" notation
 100 of a date and the "number of days" representation, which is better suited
 101 for calculations. The days are numbered from March 1st year 1 B.C., starting
 102 with zero, so the number of a day gives the number of days since March 1st,
 103 year 1 B.C. The conversions work for nonnegative day numbers only.
 104 .Pp
 105 The
 106 .Fn gdate
 107 and
 108 .Fn jdate
 109 functions
 110 store the date corresponding to the day number
 111 .Fa nd
 112 into the structure pointed at by
 113 .Fa dt
 114 and return a pointer to this structure.
 115 .Pp
 116 The
 117 .Fn ndaysg
 118 and
 119 .Fn ndaysj
 120 functions
 121 return the day number of the date pointed at by
 122 .Fa dt .
 123 .Pp
 124 The
 125 .Fn gdate
 126 and
 127 .Fn ndaysg
 128 functions
 129 assume Gregorian Calendar after October 4, 1582 and Julian Calendar before,
 130 whereas
 131 .Fn jdate
 132 and
 133 .Fn ndaysj
 134 assume Julian Calendar throughout.
 135 .Pp
 136 The two calendars differ by the definition of the leap year. The
 137 Julian Calendar says every year that is a multiple of four is a
 138 leap year. The Gregorian Calendar excludes years that are multiples of
 139 100 and not multiples of 400.
 140 This means the years 1700, 1800, 1900, 2100 are not leap years
 141 and the year 2000 is
 142 a leap year.
 143 The new rules were inaugurated on October 4, 1582 by deleting ten
 144 days following this date. Most catholic countries adopted the new
 145 calendar by the end of the 16th century, whereas others stayed with
 146 the Julian Calendar until the 20th century. The United Kingdom and
 147 their colonies switched on September 2, 1752. They already had to
 148 delete 11 days.
 149 .Pp
 150 The function
 151 .Fn week
 152 returns the number of the week which contains the day numbered
 153 .Fa nd .
 154 The argument
 155 .Fa *year
 156 is set with the year that contains (the greater part of) the week.
 157 The weeks are numbered per year starting with week 1, which is the
 158 first week in a year that includes more than three days of the year.
 159 Weeks start on Monday.
 160 This function is defined for Gregorian Calendar only.
 161 .Pp
 162 The function
 163 .Fn weekday
 164 returns the weekday (Mo = 0 .. Su = 6) of the day numbered
 165 .Fa nd .
 166 .Pp
 167 The structure
 168 .Fa date
 169 is defined in
 170 .Aq Pa calendar.h .
 171 It contains these fields:
 172 .Bd -literal -offset indent
 173 int y;          /\(** year (0000 - ????) \(**/
 174 int m;          /\(** month (1 - 12) \(**/
 175 int d;          /\(** day of month (1 - 31) \(**/
 176 .Ed
 177 .Pp
 178 The year zero is written as "1 B.C." by historians and "0" by astronomers
 179 and in this library.
 180 .Sh SEE ALSO
 181 .Xr ncal 1 ,
 182 .Xr strftime 3
 183 .Rs
 184 .%A A. B. Author
 185 .%D November 1997
 186 .Sh STANDARDS
 187 The week number conforms to ISO 8601: 1988.
 188 .Sh HISTORY
 189 The
 190 .Nm calendar
 191 library first appeared in
 192 .Fx 3.0 .
 193 .Sh AUTHORS
 194 This manual page and the library was written by
 195 .An Wolfgang Helbig Aq helbig@FreeBSD.org .
 196 .Sh BUGS
 197 The library was coded with great care so there are no bugs left.