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: src/lib/libcalendar/calendar.3,v 1.6.2.5 2001/12/17 10:08:28 ru Exp $
  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 LIBRARY
  42 .Lb libcalendar
  43 .Sh SYNOPSIS
  44 .In calendar.h
  45 .Ft struct date *
  46 .Fn easterg "int year" "struct date *dt"
  47 .Ft struct date *
  48 .Fn easterog "int year" "struct date *dt"
  49 .Ft struct date *
  50 .Fn easteroj "int year" "struct date *dt"
  51 .Ft struct date *
  52 .Fn gdate "int nd" "struct date *dt"
  53 .Ft struct date *
  54 .Fn jdate "int nd" "struct date *dt"
  55 .Ft int
  56 .Fn ndaysg "struct date *dt"
  57 .Ft int
  58 .Fn ndaysj "struct date *dt"
  59 .Ft int
  60 .Fn week "int nd" "int *year"
  61 .Ft int
  62 .Fn weekday "int nd"
  63 .Sh DESCRIPTION
  64 These functions provide calendar arithmetic for a large range of years,
  65 starting at March 1st, year zero (i. e. 1 B.C.) and ending way beyond
  66 year 100000.
  67 .Pp
  68 Programs should be linked with
  69 .Fl lcalendar .
  70 .Pp
  71 The functions
  72 .Fn easterg ,
  73 .Fn easterog
  74 and
  75 .Fn easteroj
  76 store the date of Easter Sunday into the structure pointed at by
  77 .Fa dt
  78 and return a pointer to this structure.
  79 The function
  80 .Fn easterg
  81 assumes Gregorian Calendar (adopted by most western churches after 1582) and
  82 the functions
  83 .Fn easterog
  84 and
  85 .Fn easteroj
  86 compute the date of Easter Sunday according to the orthodox rules
  87 (Western churches before 1582, Greek and Russian Orthodox Church
  88 until today).
  89 The result returned by
  90 .Fn easterog
  91 is the date in Gregorian Calendar, whereas
  92 .Fn easteroj
  93 returns the date in Julian Calendar.
  94 .Pp
  95 The functions
  96 .Fn gdate ,
  97 .Fn jdate ,
  98 .Fn ndaysg
  99 and
 100 .Fn ndaysj
 101 provide conversions between the common "year, month, day" notation
 102 of a date and the "number of days" representation, which is better suited
 103 for calculations.
 104 The days are numbered from March 1st year 1 B.C., starting
 105 with zero, so the number of a day gives the number of days since March 1st,
 106 year 1 B.C. The conversions work for nonnegative day numbers only.
 107 .Pp
 108 The
 109 .Fn gdate
 110 and
 111 .Fn jdate
 112 functions
 113 store the date corresponding to the day number
 114 .Fa nd
 115 into the structure pointed at by
 116 .Fa dt
 117 and return a pointer to this structure.
 118 .Pp
 119 The
 120 .Fn ndaysg
 121 and
 122 .Fn ndaysj
 123 functions
 124 return the day number of the date pointed at by
 125 .Fa dt .
 126 .Pp
 127 The
 128 .Fn gdate
 129 and
 130 .Fn ndaysg
 131 functions
 132 assume Gregorian Calendar after October 4, 1582 and Julian Calendar before,
 133 whereas
 134 .Fn jdate
 135 and
 136 .Fn ndaysj
 137 assume Julian Calendar throughout.
 138 .Pp
 139 The two calendars differ by the definition of the leap year.
 140 The
 141 Julian Calendar says every year that is a multiple of four is a
 142 leap year.
 143 The Gregorian Calendar excludes years that are multiples of
 144 100 and not multiples of 400.
 145 This means the years 1700, 1800, 1900, 2100 are not leap years
 146 and the year 2000 is
 147 a leap year.
 148 The new rules were inaugurated on October 4, 1582 by deleting ten
 149 days following this date.
 150 Most catholic countries adopted the new
 151 calendar by the end of the 16th century, whereas others stayed with
 152 the Julian Calendar until the 20th century.
 153 The United Kingdom and
 154 their colonies switched on September 2, 1752. They already had to
 155 delete 11 days.
 156 .Pp
 157 The function
 158 .Fn week
 159 returns the number of the week which contains the day numbered
 160 .Fa nd .
 161 The argument
 162 .Fa *year
 163 is set with the year that contains (the greater part of) the week.
 164 The weeks are numbered per year starting with week 1, which is the
 165 first week in a year that includes more than three days of the year.
 166 Weeks start on Monday.
 167 This function is defined for Gregorian Calendar only.
 168 .Pp
 169 The function
 170 .Fn weekday
 171 returns the weekday (Mo = 0 .. Su = 6) of the day numbered
 172 .Fa nd .
 173 .Pp
 174 The structure
 175 .Fa date
 176 is defined in
 177 .In calendar.h .
 178 It contains these fields:
 179 .Bd -literal -offset indent
 180 int y;          /\(** year (0000 - ????) \(**/
 181 int m;          /\(** month (1 - 12) \(**/
 182 int d;          /\(** day of month (1 - 31) \(**/
 183 .Ed
 184 .Pp
 185 The year zero is written as "1 B.C." by historians and "0" by astronomers
 186 and in this library.
 187 .Sh SEE ALSO
 188 .Xr ncal 1 ,
 189 .Xr strftime 3
 190 .Sh STANDARDS
 191 The week number conforms to ISO 8601: 1988.
 192 .Sh HISTORY
 193 The
 194 .Nm calendar
 195 library first appeared in
 196 .Fx 3.0 .
 197 .Sh AUTHORS
 198 This manual page and the library were written by
 199 .An Wolfgang Helbig Aq Mt helbig@FreeBSD.org .
 200 .Sh BUGS
 201 The library was coded with great care so there are no bugs left.