BSD 4_4 release
[unix-history] / usr / src / usr.bin / calendar / calendar.1
index 899da0f..1ffa5e5 100644 (file)
-.\"    @(#)calendar.1  6.1 (Berkeley) %G%
+.\" Copyright (c) 1989, 1990, 1993
+.\"    The Regents of the University of California.  All rights reserved.
 .\"
 .\"
-.TH CALENDAR 1 ""
-.AT 3
-.SH NAME
-calendar \- reminder service
-.SH SYNOPSIS
-.B calendar
-[ \- ]
-.SH DESCRIPTION
-.I Calendar 
-consults the file `calendar' in the current directory
-and prints out lines that contain today's or
-tomorrow's date anywhere in the line.
-Most reasonable month-day dates such as `Dec. 7,'
-`december 7,' `12/7,' etc., are recognized, but not
-`7 December' or `7/12'.
-If you give the month as ``*''
-with a date, i.e. ``* 1'', that day in any month will do.
-On weekends `tomorrow' extends through Monday.
-.PP
-When 
-an argument is present,
-.I calendar
-does its job for every user
-who has a file `calendar' in his login directory
-and sends him any positive results by
-.IR mail (1).
-Normally this is done daily in the wee hours under control of
-.IR cron (8).
-.PP
-The file `calendar' is first run through the ``C'' preprocessor,
-.IR /lib/cpp ,
-to include any other calendar files
-specified with the usual ``#include'' syntax.
-Included calendars will usually be shared by all users,
-maintained and documented by the local administration.
-.SH FILES
-calendar
-.br
-/usr/lib/calendar to figure out today's and tomorrow's dates
-.br
-/etc/passwd
-.br
-/tmp/cal*
-.br
-/lib/cpp, egrep, sed, mail as subprocesses
-.SH "SEE ALSO"
-at(1), cron(8), mail(1)
-.SH BUGS
-.I Calendar's
-extended idea of `tomorrow' doesn't account for
-holidays.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)calendar.1 8.1 (Berkeley) 6/29/93
+.\"
+.Dd June 29, 1993
+.Dt CALENDAR 1
+.Os
+.Sh NAME
+.Nm calendar
+.Nd reminder service
+.Sh SYNOPSIS
+.Nm calendar
+.Op Fl a
+.Sh DESCRIPTION
+.Nm Calendar
+checks the current directory for a file named
+.Pa calendar
+and displays lines that begin with either today's date
+or tomorrow's.
+On Fridays, events on Friday through Monday are displayed.
+.Pp
+The following options are available:
+.Bl -tag -width Ds
+.It Fl a
+Process the ``calendar'' files of all users and mail the results
+to them.
+This requires super-user privileges.
+.El
+.Pp
+Lines should begin with a month and day.
+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 tabs 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.
+.Pp
+The ``calendar'' file is preprocessed by
+.Xr 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,
+.Xr cpp 1
+searches in the current (or home) directory first, and then in the
+directory
+.Pa /usr/share/calendar .
+Empty lines and lines protected by the C commenting syntax
+.Pq Li /* ... */
+are ignored.
+.Pp
+Some possible calendar entries:
+.Bd -unfilled -offset indent
+#include       <calendar.usholiday>
+#include       <calendar.birthday>
+
+6/15           ... June 15 (if ambiguous, will default to month/day).
+Jun. 15                ... June 15.
+15 June                ... June 15.
+Thursday       ... Every Thursday.
+June           ... Every June 1st.
+15 *           ... 15th of every month.
+.Ed
+.Sh FILES
+The following default calendar files are provided:
+.Pp
+.Bl -tag -width calendar.christian -compact
+.It Pa calendar.birthday
+Births and deaths of famous (and not-so-famous) people.
+.It Pa 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.
+.It Pa calendar.computer
+Days of special significance to computer people.
+.It Pa calendar.history
+Everything  else,  mostly  U. S. historical events.
+.It Pa calendar.holiday
+Other  holidays,  including  the  not-well-known,  obscure, and
+.Em really
+obscure.
+.It Pa 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.
+.It Pa calendar.music
+Musical  events,  births, and deaths.
+Strongly  oriented  toward  rock 'n' roll.
+.It Pa 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.
+.El
+.Sh SEE ALSO
+.Xr at 1 ,
+.Xr cpp 1 ,
+.Xr cron 8
+.Xr mail 1 ,
+.Sh COMPATIBILITY
+The
+.Nm calendar
+program previously selected lines which had the correct date anywhere
+in the line.
+This is no longer true, the date is only recognized when it occurs
+first on the line.
+.Sh HISTORY
+A
+.Nm
+command appeared in Version 7 AT&T UNIX.
+.Sh BUGS
+.Nm Calendar
+doesn't handle events that move around from year to year, i.e.,
+``the last Monday in April''.