xref: /original-bsd/usr.bin/calendar/calendar.1 (revision 28f06fc7)
Copyright (c) 1989 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)calendar.1 6.4 (Berkeley) 11/27/89

CALENDAR 1 ""
C 7
NAME
calendar - reminder service
SYNOPSIS
calendar [ -a ]
DESCRIPTION
Calendar reads the file ``calendar'' in the current directory and displays lines that begin with either today's or tomorrow's date. On Fridays, events on Friday through Monday are displayed.

The following options are available:

-a Process the ``calendar'' files of all users and mail the results to them. This requires super-user privileges.

A month and day should begin lines. They may be entered in almost any format, either numeric or as character strings. A single asterisk (``*'') matches every month. A day without a month matches that day of every week. A month without a day matches the first of that month. Two numbers default to the month followed by the day. Lines with leading whitespace default to the last entered date, allowing multiple line specifications for a single date. By convention, dates followed by an asterisk are not fixed, i.e. change from year to year.

The ``calendar'' file is preprocessed by cpp (1), allowing the inclusion of shared files such as company holidays or meetings. If the shared file is not referenced by a full pathname, cpp searches in the current (or home) directory first, and then in the directory /usr/share/calendar . Empty lines and lines protected by the C commenting syntax (/* ... */) are ignored.

Some possible calendar entries:

#include <calendar.usholiday>
#include <calendar.birthday>
6/15 ... June 15 (ambiguous, default to month/day).
Jun. 15 ... June 15.
15 June ... June 15.
Thursday ... Every Thursday.
June ... Every June 1st.
15 * ... 15th of every month.

FILES
The following default calendar files are provided:

calendar.birthday Births and deaths of famous (and not-so-famous) people.

calendar.christian Christian holidays. This calendar should be updated yearly by the local system administrator so that roving holidays are set correctly for the current year.

calendar.computer Days of special significance to computer people.

calendar.history Everything else, mostly U.S. historical events.

calendar.holiday Other holidays, including the not-well-known, obscure, and really obscure.

calendar.judaic Jewish holidays. This calendar should be updated yearly by the local system administrator so that roving holidays are set correctly for the current year.

calendar.music Musical events, births, and deaths. Strongly oriented toward rock 'n' roll.

calendar.usholiday U.S. holidays. This calendar should be updated yearly by the local system administrator so that roving holidays are set correctly for the current year.

"SEE ALSO"
at(1), cpp(1), mail(1), cron(8)
BUGS
Calendar doesn't handle events that move around from year to year, i.e. ``the last Monday in April''.