xref: /original-bsd/usr.bin/calendar/calendar.1 (revision 703f6d5d)
1.\" Copyright (c) 1989, 1990 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)calendar.1	6.13 (Berkeley) 06/17/91
7.\"
8.Dd
9.Dt CALENDAR 1
10.Os
11.Sh NAME
12.Nm calendar
13.Nd reminder service
14.Sh SYNOPSIS
15.Nm calendar
16.Op Fl a
17.Sh DESCRIPTION
18.Nm Calendar
19checks the current directory for a file named named
20.Pa calendar
21and displays lines that begin with either today's date
22or tomorrow's.
23On Fridays, events on Friday through Monday are displayed.
24.Pp
25The following options are available:
26.Bl -tag -width Ds
27.It Fl a
28Process the ``calendar'' files of all users and mail the results
29to them.
30This requires super-user privileges.
31.El
32.Pp
33A month and day should begin lines.
34They may be entered in almost any format, either numeric or as character
35strings.
36A single asterisk (``*'') matches every month.
37A day without a month matches that day of every week.
38A month without a day matches the first of that month.
39Two numbers default to the month followed by the day.
40Lines with leading tabs default to the last entered date, allowing
41multiple line specifications for a single date.
42By convention, dates followed by an asterisk are not fixed, i.e. change
43from year to year.
44.Pp
45The ``calendar'' file is preprocessed by
46.Xr cpp 1 ,
47allowing the inclusion of shared files such as company holidays or
48meetings.
49If the shared file is not referenced by a full pathname,
50.Xr cpp 1
51searches in the current (or home) directory first, and then in the
52directory
53.Pa /usr/share/calendar .
54Empty lines and lines protected by the C commenting syntax
55.Pq Li /* ... */
56are ignored.
57.Pp
58Some possible calendar entries:
59.Bd -unfilled -offset indent
60#include	<calendar.usholiday>
61#include	<calendar.birthday>
62
636/15		... June 15 (if ambiguous, will default to month/day).
64Jun. 15	... June 15.
6515 June	... June 15.
66Thursday	... Every Thursday.
67June		... Every June 1st.
6815 *		... 15th of every month.
69.Ed
70.Sh FILES
71The following default calendar files are provided:
72.Pp
73.Bl -tag -width calendar.christian -compact
74.It Pa calendar.birthday
75Births and deaths of famous (and not-so-famous) people.
76.It Pa calendar.christian
77Christian holidays.
78This calendar should be updated yearly by the local system administrator
79so that roving holidays are set correctly for the current year.
80.It Pa calendar.computer
81Days of special significance to computer people.
82.It Pa calendar.history
83Everything  else,  mostly  U. S. historical events.
84.It Pa calendar.holiday
85Other  holidays,  including  the  not-well-known,  obscure, and
86.Em really
87obscure.
88.It Pa calendar.judaic
89Jewish holidays.
90This calendar should be updated yearly by the local system administrator
91so that roving holidays are set correctly for the current year.
92.It Pa calendar.music
93Musical  events,  births, and deaths.
94Strongly  oriented  toward  rock 'n' roll.
95.It Pa calendar.usholiday
96U.S. holidays.
97This calendar should be updated yearly by the local system administrator
98so that roving holidays are set correctly for the current year.
99.El
100.Sh SEE ALSO
101.Xr at 1 ,
102.Xr cpp 1 ,
103.Xr cron 8
104.Xr mail 1 ,
105.Sh COMPATIBILITY
106The
107.Nm calendar
108program previously selected lines which had the correct date anywhere
109in the line.
110This is no longer true, the date is only recognized when it occurs
111first on the line.
112.Sh HISTORY
113A
114.Nm
115command appeared in Version 7 AT&T UNIX.
116.Sh BUGS
117.Nm Calendar
118doesn't handle events that move around from year to year, i.e.
119``the last Monday in April''.
120