=================================================================== RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/calendar/calendar.1,v retrieving revision 1.2 retrieving revision 1.18 diff -u -r1.2 -r1.18 --- src/usr.bin/calendar/calendar.1 1996/06/26 05:31:45 1.2 +++ src/usr.bin/calendar/calendar.1 2002/03/20 22:59:56 1.18 @@ -1,8 +1,7 @@ -.\" $OpenBSD: calendar.1,v 1.2 1996/06/26 05:31:45 deraadt Exp $ -.\" $NetBSD: calendar.1,v 1.7 1995/03/27 08:46:13 glass Exp $ +.\" $OpenBSD: calendar.1,v 1.18 2002/03/20 22:59:56 mickey Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 -.\" The Regents of the University of California. All rights reserved. +.\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -14,8 +13,8 @@ .\" 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. +.\" 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. @@ -32,7 +31,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" @(#)calendar.1 8.1 (Berkeley) 6/29/93 +.\" @(#)calendar.1 8.1 (Berkeley) 6/29/93 .\" .Dd June 29, 1993 .Dt CALENDAR 1 @@ -43,38 +42,100 @@ .Sh SYNOPSIS .Nm calendar .Op Fl a +.Op Fl A Ar num +.Op Fl b +.Op Fl B Ar num +.Op Fl f Ar calendarfile +.Op Fl t Ar [[[cc]yy][mm]]dd .Sh DESCRIPTION -The -.Nm calendar +The +.Nm utility checks the current directory or the directory specified by the -.Dq Ev CALENDAR_DIR +.Ev CALENDAR_DIR environment variable 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: +The options are as follows: .Bl -tag -width Ds .It Fl a -Process the ``calendar'' files of all users and mail the results +Process the +.Dq calendar +files of all users and mail the results to them. -This requires super-user privileges. +This requires superuser privileges. +.It Fl A Ar num +Print lines from today and next +.Ar num +days (forward, future). +.It Fl b +Enforce special date calculation mode for KOI8 calendars. +.It Fl B Ar num +Print lines from today and previous +.Ar num +days (backward, past). +.It Fl f Pa calendarfile +Use +.Pa calendarfile +as the default calendar file. +.It Fl t Ar [[[cc]yy][mm]]dd +Act like the specified value is +.Dq today +instead of using the current date. .El .Pp -Lines should begin with a month and day. +To handle calendars in your national code table you can specify +.Dq LANG= +in the calendar file as early as possible. +To handle national Easter names in the calendars, +.Dq Easter= +(for Catholic Easter) or +.Dq Paskha= +(for Orthodox Easter) can be used. +.Pp +To enforce special date calculation mode for Cyrillic calendars +you should specify +.Dq LANG= +and +.Dq BODUN= +where can be ru_RU.KOI8-R, uk_UA.KOI8-U or by_BY.KOI8-B. +.Pp +Other 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. +If proper locale is set, national months and weekdays +names can be used. +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 +.Dq Easter +(may be followed by a positive or negative integer) is Easter for this year. +.Dq Paskha +(may be followed by a positive or negative integer) is +Orthodox Easter for this year. +Weekdays may be followed by +.Dq -4 +.Li ... +.Dq +5 +(aliases last, first, second, third, fourth) for moving events like +.Dq the last Monday in April . +.Pp +By convention, dates followed by an asterisk +.Pq Sq * +are not fixed, i.e., change from year to year. .Pp -The ``calendar'' file is preprocessed by +Day descriptions start after the first character in the line; +if the line does not contain a character, it isn't printed out. +If the first character in the line is a character, it is treated as +the continuation of the previous description. +.Pp +The calendar file is preprocessed by .Xr cpp 1 , allowing the inclusion of shared files such as company holidays or meetings. @@ -87,65 +148,94 @@ .Pq Li /* ... */ are ignored. .Pp -Some possible calendar entries: +Some possible calendar entries ( characters are highlighted by a +\fB\et\fR sequence): .Bd -unfilled -offset indent -#include -#include +LANG=C +Easter=Ostern -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. +#include +#include + +6/15\fB\et\fRJune 15 (if ambiguous, will default to month/day). +Jun. 15\fB\et\fRJune 15. +15 June\fB\et\fRJune 15. +Thursday\fB\et\fREvery Thursday. +June\fB\et\fREvery June 1st. +15 *\fB\et\fR15th of every month. + +May Sun+2\fB\et\fRsecond Sunday in May (Muttertag) +04/SunLast\fB\et\fRlast Sunday in April, +\fB\et\fRsummer time in Europe +Easter\fB\et\fREaster +Ostern-2\fB\et\fRGood Friday (2 days before Easter) +Paskha\fB\et\fROrthodox Easter .Ed .Sh FILES -The following default calendar files are provided: -.Pp -.Bl -tag -width calendar.christian -compact +.Bl -tag -width ~/.calendar/calendar -compact +.It Pa calendar +file in current directory +.It Pa ~/.calendar +file in home directory (which +.Nm +.Xr chdir 1 's +into if it exists) +.It Pa ~/.calendar/calendar +file to use if no calendar file exists in the current directory +.It Pa ~/.calendar/nomail +.Nm +will not send mail if this file exists .It Pa calendar.birthday -Births and deaths of famous (and not-so-famous) people. +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. +Christian holidays (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. +days of special significance to computer people +.It Pa calendar.fictional +Fantasy and Fiction dates (mostly LOTR) .It Pa calendar.history -Everything else, mostly U. S. historical events. +everything else, mostly U.S. historical events .It Pa calendar.holiday -Other holidays, including the not-well-known, obscure, and +other holidays (including the not-well-known, obscure, and .Em really -obscure. +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. +Jewish holidays (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. +musical events, births, and deaths (strongly oriented toward rock n' roll) +.It Pa calendar.pagan +Pagan holidays, celebrations and festivals .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 +.It Pa calendar.world +World wide calendar +.It Pa calendar.croatian +Croatian calendar +.It Pa calendar.german +German calendar +.It Pa calendar.russian +Russian calendar .El .Sh SEE ALSO .Xr at 1 , +.Xr cal 1 , .Xr cpp 1 , +.Xr mail 1 , .Xr cron 8 .Sh COMPATIBILITY The -.Nm calendar +.Nm 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. +This is no longer true: the date is only recognized when it occurs +at the beginning of a line. .Sh HISTORY A .Nm -command appeared in +command appeared in .At v7 . .Sh BUGS -.Nm Calendar -doesn't handle events that move around from year to year, i.e., -``the last Monday in April''. +.Nm +doesn't handle Jewish holidays or moon phases.