usr.bin/calendar/calendar.1

   1 .\" Copyright (c) 1989, 1990, 1993
   2 .\"     The Regents of the University of California.  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 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)calendar.1  8.1 (Berkeley) 6/29/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 25, 2020
  32 .Dt CALENDAR 1
  33 .Os
  34 .Sh NAME
  35 .Nm calendar
  36 .Nd reminder service
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl A Ar num
  40 .Op Fl a
  41 .Op Fl B Ar num
  42 .Op Fl D Ar moon|sun
  43 .Op Fl d
  44 .Op Fl F Ar friday
  45 .Op Fl f Ar calendarfile
  46 .Op Fl l Ar longitude
  47 .Oo
  48 .Bk -words
  49 .Fl t Ar dd Ns
  50 .Sm off
  51 .Op . Ar mm Op . Ar year
  52 .Sm on
  53 .Ek
  54 .Oc
  55 .Op Fl U Ar UTC-offset
  56 .Op Fl W Ar num
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 utility checks the current directory for a file named
  61 .Pa calendar
  62 and displays lines that fall into the specified date range.
  63 On the day before a weekend (normally Friday), events for the next
  64 three days are displayed.
  65 .Pp
  66 The following options are available:
  67 .Bl -tag -width Ds
  68 .It Fl A Ar num
  69 Print lines from today and the next
  70 .Ar num
  71 days (forward, future).
  72 .It Fl a
  73 Process the ``calendar'' files for users found in
  74 .Pa /etc/passwd
  75 and mail the results
  76 to them.
  77 This can result in multiple messages for specific files, since
  78 .Pa /etc/passwd
  79 does not require home directories to be unique.
  80 In particular, by default
  81 .Ar root ,
  82 .Ar toor
  83 and
  84 .Ar daemon
  85 share the same home directory.
  86 If this directory contains calendar information,
  87 .Nm
  88 will process the file three times.
  89 .Pp
  90 This option requires super-user privileges.
  91 .It Fl B Ar num
  92 Print lines from today and the previous
  93 .Ar num
  94 days (backward, past).
  95 .It Fl D Ar moon|sun
  96 Print UTC offset, longitude and moon or sun information.
  97 .It Fl d
  98 Debug option: print current date information.
  99 .It Fl F Ar friday
 100 Specify which day of the week is ``Friday'' (the day before the
 101 weekend begins).
 102 Default is 5.
 103 .It Fl f Pa calendarfile
 104 Use
 105 .Pa calendarfile
 106 as the default calendar file.
 107 .It Fl l Ar longitude
 108 Perform lunar and solar calculations from this longitude.
 109 If neither longitude nor UTC offset is specified, the calculations will
 110 be based on the difference between UTC time and localtime.
 111 If both are specified, UTC offset overrides longitude.
 112 .It Xo Fl t
 113 .Sm off
 114 .Ar dd
 115 .Op . Ar mm Op . Ar year
 116 .Sm on
 117 .Xc
 118 For test purposes only: set date directly to argument values.
 119 .It Fl U Ar UTC-offset
 120 Perform lunar and solar calculations from this UTC offset.
 121 If neither UTC offset nor longitude is specified, the calculations
 122 will be based on the difference between UTC time and localtime.
 123 If both are specified, UTC offset overrides longitude.
 124 .It Fl W Ar num
 125 Print lines from today and the next
 126 .Ar num
 127 days (forward, future).
 128 Ignore weekends when calculating the number of days.
 129 .El
 130 .Sh FILE FORMAT
 131 To handle calendars in your national code table you can specify
 132 .Dq LANG=<locale_name>
 133 in the calendar file as early as possible.
 134 .Pp
 135 To handle the local name of sequences, you can specify them as:
 136 .Dq SEQUENCE=<first> <second> <third> <fourth> <fifth> <last>
 137 in the calendar file as early as possible.
 138 .Pp
 139 The names of the following special days are recognized:
 140 .Bl -tag -width 123456789012345 -compact
 141 .It Easter
 142 Catholic Easter.
 143 .It Paskha
 144 Orthodox Easter.
 145 .It NewMoon
 146 The lunar New Moon.
 147 .It FullMoon
 148 The lunar Full Moon.
 149 .It MarEquinox
 150 The solar equinox in March.
 151 .It JunSolstice
 152 The solar solstice in June.
 153 .It SepEquinox
 154 The solar equinox in September.
 155 .It DecSolstice
 156 The solar solstice in December.
 157 .It ChineseNewYear
 158 The first day of the Chinese year.
 159 .El
 160 These names may be reassigned to their local names via an assignment
 161 like
 162 .Dq Easter=Pasen
 163 in the calendar file.
 164 .Pp
 165 Other lines should begin with a month and day.
 166 They may be entered in almost any format, either numeric or as character
 167 strings.
 168 If the proper locale is set, national month and weekday
 169 names can be used.
 170 A single asterisk (``*'') matches every month.
 171 A day without a month matches that day of every week.
 172 A month without a day matches the first of that month.
 173 Two numbers default to the month followed by the day.
 174 Lines with leading tabs default to the last entered date, allowing
 175 multiple line specifications for a single date.
 176 .Pp
 177 The names of the recognized special days may be followed by a
 178 positive or negative integer, like:
 179 .Dq Easter+3
 180 or
 181 .Dq Paskha-4 .
 182 .Pp
 183 Weekdays may be followed by ``-4'' ...\& ``+5'' (aliases for
 184 last, first, second, third, fourth) for moving events like
 185 ``the last Monday in April''.
 186 .Pp
 187 By convention, dates followed by an asterisk are not fixed, i.e., change
 188 from year to year.
 189 .Pp
 190 Day descriptions start after the first <tab> character in the line;
 191 if the line does not contain a <tab> character, it is not displayed.
 192 If the first character in the line is a <tab> character, it is treated as
 193 a continuation of the previous line.
 194 .Pp
 195 The
 196 .Nm
 197 file is preprocessed by a limited subset of
 198 .Xr cpp 1
 199 internally, allowing the inclusion of shared files such as
 200 lists of company holidays or meetings.
 201 This limited subset consists of \fB#include #ifndef #endif\fR and \fB#define\fR.
 202 If the shared file is not referenced by a full pathname,
 203 .Nm
 204 searches in the current (or home) directory first, and then in the
 205 directory
 206 .Pa /usr/share/calendar .
 207 Empty lines and lines protected by the C commenting syntax
 208 .Pq Li /* ... */
 209 are ignored.
 210 .Pp
 211 Some possible calendar entries (<tab> characters highlighted by
 212 \fB\et\fR sequence)
 213 .Bd -unfilled -offset indent
 214 LANG=C
 215 Easter=Ostern
 216
 217 #include <calendar.usholiday>
 218 #include <calendar.birthday>
 219
 220 6/15\fB\et\fRJune 15 (if ambiguous, will default to month/day).
 221 Jun. 15\fB\et\fRJune 15.
 222 15 June\fB\et\fRJune 15.
 223 Thursday\fB\et\fREvery Thursday.
 224 June\fB\et\fREvery June 1st.
 225 15 *\fB\et\fR15th of every month.
 226 2010/4/15\fB\et\fR15 April 2010
 227
 228 May Sun+2\fB\et\fRsecond Sunday in May (Muttertag)
 229 04/SunLast\fB\et\fRlast Sunday in April,
 230 \fB\et\fRsummer time in Europe
 231 Easter\fB\et\fREaster
 232 Ostern-2\fB\et\fRGood Friday (2 days before Easter)
 233 Paskha\fB\et\fROrthodox Easter
 234
 235 .Ed
 236 .Sh FILES
 237 .Bl -tag -width calendar.christian -compact
 238 .It Pa calendar
 239 file in current directory.
 240 .It Pa ~/.calendar
 241 .Pa calendar
 242 HOME directory.
 243 A chdir is done into this directory if it exists.
 244 .It Pa ~/.calendar/calendar
 245 calendar file to use if no calendar file exists in the current directory.
 246 .It Pa ~/.calendar/nomail
 247 do not send mail if this file exists.
 248 .It Pa /usr/share/calendar
 249 system wide location of calendar files provided as part of the base system.
 250 .It Pa /usr/local/share/calendar
 251 system wide location for calendar files provided by a port or package.
 252 .El
 253 .Pp
 254 The order of precedence in searches for a calendar file is:
 255 current directory, ~/.calendar, /usr/local/share/calendar, /usr/share/calendar.
 256 Files of similar names are ignored in lower precedence locations.
 257 .Pp
 258 The following default calendar files are provided by the
 259 deskutils/calendar-data port.
 260 .Pp
 261 .Bl -tag -width calendar.southafrica -compact
 262 .It Pa calendar.all
 263 File which includes all the default files.
 264 .It Pa calendar.australia
 265 Calendar of events in Australia.
 266 .It Pa calendar.birthday
 267 Births and deaths of famous (and not-so-famous) people.
 268 .It Pa calendar.christian
 269 Christian holidays.
 270 This calendar should be updated yearly by the local system administrator
 271 so that roving holidays are set correctly for the current year.
 272 .It Pa calendar.computer
 273 Days of special significance to computer people.
 274 .It Pa calendar.croatian
 275 Calendar of events in Croatia.
 276 .It Pa calendar.dutch
 277 Calendar of events in the Netherlands.
 278 .It Pa calendar.freebsd
 279 Birthdays of
 280 .Fx
 281 committers.
 282 .It Pa calendar.french
 283 Calendar of events in France.
 284 .It Pa calendar.german
 285 Calendar of events in Germany.
 286 .It Pa calendar.history
 287 Everything else, mostly U.S.\& historical events.
 288 .It Pa calendar.holiday
 289 Other holidays, including the not-well-known, obscure, and
 290 .Em really
 291 obscure.
 292 .It Pa calendar.judaic
 293 Jewish holidays.
 294 The entries for this calendar have been obtained from the
 295 deskutils/hebcal port.
 296 .It Pa calendar.music
 297 Musical events, births, and deaths.
 298 Strongly oriented toward rock 'n' roll.
 299 .It Pa calendar.newzealand
 300 Calendar of events in New Zealand.
 301 .It Pa calendar.russian
 302 Russian calendar.
 303 .It Pa calendar.southafrica
 304 Calendar of events in South Africa.
 305 .It Pa calendar.usholiday
 306 U.S.\& holidays.
 307 This calendar should be updated yearly by the local system administrator
 308 so that roving holidays are set correctly for the current year.
 309 .It Pa calendar.world
 310 Includes all calendar files except for national files.
 311 .El
 312 .Sh COMPATIBILITY
 313 The
 314 .Nm
 315 program previously selected lines which had the correct date anywhere
 316 in the line.
 317 This is no longer true, the date is only recognized when it occurs
 318 at the beginning of a line.
 319 .Sh SEE ALSO
 320 .Xr at 1 ,
 321 .Xr mail 1 ,
 322 .Xr cron 8
 323 .Sh HISTORY
 324 A
 325 .Nm
 326 command appeared in
 327 .At v7 .
 328 .Sh NOTES
 329 Chinese New Year is calculated at 120 degrees east of Greenwich,
 330 which roughly corresponds with the east coast of China.
 331 For people west of China, this might result that the start of Chinese
 332 New Year and the day of the related new moon might differ.
 333 .Pp
 334 The phases of the moon and the longitude of the sun are calculated
 335 against the local position which corresponds with 30 degrees times
 336 the time-difference towards Greenwich.
 337 .Pp
 338 The new and full moons are happening on the day indicated: They
 339 might happen in the time period in the early night or in the late
 340 evening.
 341 It does not indicate that they are starting in the night on that date.
 342 .Pp
 343 Because of minor differences between the output of the formulas
 344 used and other sources on the Internet, Druids and Werewolves should
 345 double-check the start and end time of solar and lunar events.
 346 .Sh BUGS
 347 The
 348 .Nm
 349 internal cpp does not correctly do #ifndef and will discard the rest
 350 of the file if a #ifndef is triggered.
 351 It also has a maximum of 50 include file and/or 100 #defines
 352 and only recognises #include, #define and
 353 #ifndef.
 354 .Pp
 355 There is no possibility to properly specify the local position
 356 needed for solar and lunar calculations.