Return to calendar.1 CVS log

Up to [local] / src / usr.bin / calendar

Annotation of src/usr.bin/calendar/calendar.1, Revision 1.1.1.1

1.1       deraadt     1: .\"    $NetBSD: calendar.1,v 1.7 1995/03/27 08:46:13 glass Exp $
                      2: .\"
                      3: .\" Copyright (c) 1989, 1990, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
                      5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\" 1. Redistributions of source code must retain the above copyright
                     10: .\"    notice, this list of conditions and the following disclaimer.
                     11: .\" 2. Redistributions in binary form must reproduce the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer in the
                     13: .\"    documentation and/or other materials provided with the distribution.
                     14: .\" 3. All advertising materials mentioning features or use of this software
                     15: .\"    must display the following acknowledgement:
                     16: .\"    This product includes software developed by the University of
                     17: .\"    California, Berkeley and its contributors.
                     18: .\" 4. Neither the name of the University nor the names of its contributors
                     19: .\"    may be used to endorse or promote products derived from this software
                     20: .\"    without specific prior written permission.
                     21: .\"
                     22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     25: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     32: .\" SUCH DAMAGE.
                     33: .\"
                     34: .\"     @(#)calendar.1 8.1 (Berkeley) 6/29/93
                     35: .\"
                     36: .Dd June 29, 1993
                     37: .Dt CALENDAR 1
                     38: .Os
                     39: .Sh NAME
                     40: .Nm calendar
                     41: .Nd reminder service
                     42: .Sh SYNOPSIS
                     43: .Nm calendar
                     44: .Op Fl a
                     45: .Sh DESCRIPTION
                     46: The
                     47: .Nm calendar
                     48: utility checks the current directory or the directory specified by the
                     49: .Dq Ev CALENDAR_DIR
                     50: environment variable for a file named
                     51: .Pa calendar
                     52: and displays lines that begin with either today's date
                     53: or tomorrow's.
                     54: On Fridays, events on Friday through Monday are displayed.
                     55: .Pp
                     56: The following options are available:
                     57: .Bl -tag -width Ds
                     58: .It Fl a
                     59: Process the ``calendar'' files of all users and mail the results
                     60: to them.
                     61: This requires super-user privileges.
                     62: .El
                     63: .Pp
                     64: Lines should begin with a month and day.
                     65: They may be entered in almost any format, either numeric or as character
                     66: strings.
                     67: A single asterisk (``*'') matches every month.
                     68: A day without a month matches that day of every week.
                     69: A month without a day matches the first of that month.
                     70: Two numbers default to the month followed by the day.
                     71: Lines with leading tabs default to the last entered date, allowing
                     72: multiple line specifications for a single date.
                     73: By convention, dates followed by an asterisk are not fixed, i.e., change
                     74: from year to year.
                     75: .Pp
                     76: The ``calendar'' file is preprocessed by
                     77: .Xr cpp 1 ,
                     78: allowing the inclusion of shared files such as company holidays or
                     79: meetings.
                     80: If the shared file is not referenced by a full pathname,
                     81: .Xr cpp 1
                     82: searches in the current (or home) directory first, and then in the
                     83: directory
                     84: .Pa /usr/share/calendar .
                     85: Empty lines and lines protected by the C commenting syntax
                     86: .Pq Li /* ... */
                     87: are ignored.
                     88: .Pp
                     89: Some possible calendar entries:
                     90: .Bd -unfilled -offset indent
                     91: #include       <calendar.usholiday>
                     92: #include       <calendar.birthday>
                     93:
                     94: 6/15           ... June 15 (if ambiguous, will default to month/day).
                     95: Jun. 15                ... June 15.
                     96: 15 June                ... June 15.
                     97: Thursday       ... Every Thursday.
                     98: June           ... Every June 1st.
                     99: 15 *           ... 15th of every month.
                    100: .Ed
                    101: .Sh FILES
                    102: The following default calendar files are provided:
                    103: .Pp
                    104: .Bl -tag -width calendar.christian -compact
                    105: .It Pa calendar.birthday
                    106: Births and deaths of famous (and not-so-famous) people.
                    107: .It Pa calendar.christian
                    108: Christian holidays.
                    109: This calendar should be updated yearly by the local system administrator
                    110: so that roving holidays are set correctly for the current year.
                    111: .It Pa calendar.computer
                    112: Days of special significance to computer people.
                    113: .It Pa calendar.history
                    114: Everything  else,  mostly  U. S. historical events.
                    115: .It Pa calendar.holiday
                    116: Other  holidays,  including  the  not-well-known,  obscure, and
                    117: .Em really
                    118: obscure.
                    119: .It Pa calendar.judaic
                    120: Jewish holidays.
                    121: This calendar should be updated yearly by the local system administrator
                    122: so that roving holidays are set correctly for the current year.
                    123: .It Pa calendar.music
                    124: Musical  events,  births, and deaths.
                    125: Strongly  oriented  toward  rock 'n' roll.
                    126: .It Pa calendar.usholiday
                    127: U.S. holidays.
                    128: This calendar should be updated yearly by the local system administrator
                    129: so that roving holidays are set correctly for the current year.
                    130: .El
                    131: .Sh SEE ALSO
                    132: .Xr at 1 ,
                    133: .Xr cpp 1 ,
                    134: .Xr cron 8
                    135: .Sh COMPATIBILITY
                    136: The
                    137: .Nm calendar
                    138: program previously selected lines which had the correct date anywhere
                    139: in the line.
                    140: This is no longer true, the date is only recognized when it occurs
                    141: first on the line.
                    142: .Sh HISTORY
                    143: A
                    144: .Nm
                    145: command appeared in
                    146: .At v7 .
                    147: .Sh BUGS
                    148: .Nm Calendar
                    149: doesn't handle events that move around from year to year, i.e.,
                    150: ``the last Monday in April''.