calendar(1) - NetBSD Manual Pages

CALENDAR(1)                 NetBSD Reference Manual                CALENDAR(1)


NAME

     calendar - reminder service


SYNOPSIS

     calendar [-a] [-f file] [-l days] [-w days] [-d MMDD[[YY]YY]]


DESCRIPTION

     The calendar utility processes text files and displays lines that match
     certain dates.

     The following options are available:

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

     -d MMDD[[YY]YY]
             Display lines for the given date. By default, the current date is
             used.  The year, which may be given in either two or four digit
             format, is used only for purposes of determining wether the given
             date falls on a Friday in that year (see below). If the year is
             not specified, the current year is assumed.

     -f file
             Display matching calendar files from the given filename, by de-
             fault calendar.  The filename may be absolute. If not absolute,
             it is taken relative to the current directory or the directory
             specified by the ``CALENDAR_DIR'' environment variable. Or, if
             the -a flag is given, a non-absolute filename is taken relative
             to each user's home directory in turn.

     -l days
             Causes the program to ``look ahead'' a given number of days (de-
             fault one) from the specified date and display their entries as
             well.

     -w days
             Causes the program to add the specified number of days to the
             ``look ahead'' number if and only if the day specified is a Fri-
             day. The default value is two, which causes calendar to print en-
             tries through the weekend on Fridays.

     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 specifica-
     tions 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(1) 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 (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.


FILES

     The following default calendar files are provided:

     calendar.birthday   Births and deaths of famous (and not-so-famous) peo-
                         ple.
     calendar.christian  Christian holidays.  This calendar should be updated
                         yearly by the local system administrator so that rov-
                         ing 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 rov-
                         ing holidays are set correctly for the current year.
     calendar.music      Musical  events,  births, and deaths.  Strongly  ori-
                         ented  toward  rock 'n' roll.
     calendar.usholiday  U.S. holidays.  This calendar should be updated year-
                         ly by the local system administrator so that roving
                         holidays are set correctly for the current year.


SEE ALSO

     at(1), cpp(1), cron(8)


COMPATIBILITY

     The calendar program previously selected lines which had the correct date
     anywhere in the line.  This is no longer true, the date is only recog-
     nized when it occurs first on the line.


HISTORY

     A calendar command appeared in Version 7 AT&T UNIX.


BUGS

     calendar doesn't handle events that move around from year to year, i.e.,
     ``the last Monday in April''.

NetBSD 1.6                       June 29, 1993                               2