BSD 4_4 release

[unix-history] / usr / src / usr.bin / calendar / calendar.1

diff --git a/usr/src/usr.bin/calendar/calendar.1 b/usr/src/usr.bin/calendar/calendar.1
index f967e12..1ffa5e5 100644 (file)
--- a/usr/src/usr.bin/calendar/calendar.1
+++ b/usr/src/usr.bin/calendar/calendar.1
@@ -1,117 +1,145 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1989, 1990, 1993
+.\"    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.
+.\" 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.

 .\"
 .\"

-.\"    @(#)calendar.1  6.4 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.TH CALENDAR 1 ""
-.UC 7
-.SH NAME
-calendar \- reminder service
-.SH SYNOPSIS
-.B calendar
-[ \-a ]
-.SH DESCRIPTION
-.I Calendar 
-reads the file ``calendar'' in the current directory and displays lines
-that begin with either today's or tomorrow's date.
+.\"     @(#)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.
 On Fridays, events on Friday through Monday are displayed.

-.PP
+.Pp

 The following options are available:
 The following options are available:

-.TP
-\-a
+.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.
 Process the ``calendar'' files of all users and mail the results
 to them.
 This requires super-user privileges.

-.PP
-A month and day should begin lines.
+.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.
 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
+Lines with leading tabs default to the last entered date, allowing

 multiple line specifications for a single date.
 multiple line specifications for a single date.

-By convention, dates followed by an asterisk are not fixed, i.e. change
+By convention, dates followed by an asterisk are not fixed, i.e., change

 from year to year.
 from year to year.

-.PP
+.Pp

 The ``calendar'' file is preprocessed by
 The ``calendar'' file is preprocessed by

-.IR cpp (1),
+.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,
 allowing the inclusion of shared files such as company holidays or
 meetings.
 If the shared file is not referenced by a full pathname,

-.I cpp
+.Xr cpp 1

 searches in the current (or home) directory first, and then in the
 directory
 searches in the current (or home) directory first, and then in the
 directory

-.IR /usr/share/calendar .
-Empty lines and lines protected by the C commenting syntax (/* ... */)
+.Pa /usr/share/calendar .
+Empty lines and lines protected by the C commenting syntax
+.Pq Li /* ... */

 are ignored.
 are ignored.

-.PP
+.Pp

 Some possible calendar entries:
 Some possible calendar entries:

-.in +5
-.sp
-.nf
+.Bd -unfilled -offset indent

 #include       <calendar.usholiday>
 #include       <calendar.birthday>
 #include       <calendar.usholiday>
 #include       <calendar.birthday>

-.sp
-6/15           ... June 15 (ambiguous, default to month/day).
-Jun. 15        ... June 15.
-15 June        ... June 15.
+
+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.
 Thursday       ... Every Thursday.
 June           ... Every June 1st.
 15 *           ... 15th of every month.

-.fi
-.PP
-.SH FILES
+.Ed
+.Sh FILES

 The following default calendar files are provided:
 The following default calendar files are provided:

-.TP
-calendar.birthday
+.Pp
+.Bl -tag -width calendar.christian -compact
+.It Pa calendar.birthday

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

-.TP
-calendar.christian
+.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.
 Christian holidays.
 This calendar should be updated yearly by the local system administrator
 so that roving holidays are set correctly for the current year.

-.TP
-calendar.computer
+.It Pa calendar.computer

 Days of special significance to computer people.
 Days of special significance to computer people.

-.TP
-calendar.history
-Everything else, mostly U.S. historical events.
-.TP
-calendar.holiday
-Other holidays, including the not-well-known, obscure, and
-.B really
+.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.
 obscure.

-.TP
-calendar.judaic
+.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.
 Jewish holidays.
 This calendar should be updated yearly by the local system administrator
 so that roving holidays are set correctly for the current year.

-.TP
-calendar.music
-Musical events, births, and deaths.
-Strongly oriented toward rock 'n' roll.
-.TP
-calendar.usholiday
+.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.
 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.

-.SH "SEE ALSO"
-at(1), cpp(1), mail(1), cron(8)
-.SH BUGS
-.I Calendar
-doesn't handle events that move around from year to year, i.e.
+.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''.
 ``the last Monday in April''.