[BACK]Return to calendar.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / calendar

Diff for /src/usr.bin/calendar/calendar.1 between version 1.1 and 1.40

version 1.1, 1995/10/18 08:44:57 version 1.40, 2015/12/07 18:46:35
Line 1 
Line 1 
 .\"     $NetBSD: calendar.1,v 1.7 1995/03/27 08:46:13 glass Exp $  .\"     $OpenBSD$
 .\"  .\"
 .\" Copyright (c) 1989, 1990, 1993  .\" 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  .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions  .\" modification, are permitted provided that the following conditions
Line 11 
Line 11 
 .\" 2. Redistributions in binary form must reproduce the above copyright  .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the  .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.  .\"    documentation and/or other materials provided with the distribution.
 .\" 3. All advertising materials mentioning features or use of this software  .\" 3. Neither the name of the University nor the names of its contributors
 .\"    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  .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.  .\"    without specific prior written permission.
 .\"  .\"
Line 31 
Line 27 
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF  .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.  .\" SUCH DAMAGE.
 .\"  .\"
 .\"     @(#)calendar.1  8.1 (Berkeley) 6/29/93  .\"     @(#)calendar.1  8.1 (Berkeley) 6/29/93
 .\"  .\"
 .Dd June 29, 1993  .Dd $Mdocdate$
 .Dt CALENDAR 1  .Dt CALENDAR 1
 .Os  .Os
 .Sh NAME  .Sh NAME
Line 41 
Line 37 
 .Nd reminder service  .Nd reminder service
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm calendar  .Nm calendar
 .Op Fl a  .Op Fl abw
   .Op Fl A Ar num
   .Op Fl B Ar num
   .Op Fl f Ar calendarfile
   .Op Fl t Oo Oo Oo Ar cc Oc Ns Ar yy Oc Ns Ar mm Oc Ns Ar dd
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm calendar  .Nm
 utility checks the current directory or the directory specified by the  utility checks the current directory or the directory specified by the
 .Dq Ev CALENDAR_DIR  .Ev CALENDAR_DIR
 environment variable for a file named  environment variable for a file named
 .Pa calendar  .Pa calendar
 and displays lines that begin with either today's date  and displays lines that begin with either today's date
 or tomorrow's.  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 options are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
   .It Fl A Ar num
   Print lines from today and next
   .Ar num
   days (forward, future).
 .It Fl a  .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.  to them.
 This requires super-user privileges.  This requires superuser privileges.
   .It Fl B Ar num
   Print lines from today and previous
   .Ar num
   days (backward, past).
   .It Fl b
   Enforce special date calculation mode for Cyrillic calendars.
   .It Fl f Ar calendarfile
   Use
   .Ar calendarfile
   as the default calendar file.
   .It Fl t Oo Oo Oo Ar cc Oc Ns Ar yy Oc Ns Ar mm Oc Ns Ar dd
   Act like the specified value is
   .Dq today
   instead of using the current date.
   If yy is specified, but cc is not,
   a value for yy between 69 and 99 results in a cc value of 19.
   Otherwise, a cc value of 20 is used.
   .It Fl w
   Print day of the week name in front of each event.
 .El  .El
 .Pp  .Pp
 Lines should begin with a month and day.  To handle calendars in your national code table you can specify
   .Dq LANG=<locale_name>
   in the calendar file as early as possible.
   To handle national Easter names in the calendars,
   .Dq Easter=<national_name>
   (for Catholic Easter) or
   .Dq Paskha=<national_name>
   (for Orthodox Easter) can be used.
   .Pp
   The
   .Dq CALENDAR
   variable can be used to specify the style.
   Only
   .Sq Julian
   and
   .Sq Gregorian
   styles are currently supported.
   Use
   .Dq CALENDAR=
   to return to the default (Gregorian).
   .Pp
   To enforce special date calculation mode for Cyrillic calendars
   you should specify
   .Dq LANG=<local_name>
   and
   .Dq BODUN=<bodun_prefix>
   where <local_name> can be ru_RU.UTF-8, uk_UA.UTF-8 or by_BY.UTF-8.
   .Pp
   Other lines should begin with a month and day.
 They may be entered in almost any format, either numeric or as character  They may be entered in almost any format, either numeric or as character
 strings.  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 day without a month matches that day of every week.
 A month without a day matches the first of that month.  A month without a day matches the first of that month.
 Two numbers default to the month followed by the day.  Two numbers default to the month followed by the day.
 Lines with leading tabs 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  .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.  from year to year.
 .Pp  .Pp
 The ``calendar'' file is preprocessed by  Day descriptions start after the first <tab> character in the line;
   if the line does not contain a <tab> character, it isn't printed out.
   If the first character in the line is a <tab> character, it is treated as
   the continuation of the previous description.
   .Pp
   The calendar file is preprocessed by
 .Xr cpp 1 ,  .Xr cpp 1 ,
 allowing the inclusion of shared files such as company holidays or  allowing the inclusion of shared files such as company holidays or
 meetings.  meetings.
Line 86 
Line 160 
 .Pq Li /* ... */  .Pq Li /* ... */
 are ignored.  are ignored.
 .Pp  .Pp
 Some possible calendar entries:  Some possible calendar entries
   (a \fB\et\fR sequence denotes a <tab> character):
 .Bd -unfilled -offset indent  .Bd -unfilled -offset indent
 #include        <calendar.usholiday>  LANG=C
 #include        <calendar.birthday>  Easter=Ostern
   
 6/15            ... June 15 (if ambiguous, will default to month/day).  #include <calendar.usholiday>
 Jun. 15         ... June 15.  #include <calendar.birthday>
 15 June         ... June 15.  
 Thursday        ... Every Thursday.  6/15\fB\et\fRJune 15 (if ambiguous, will default to month/day).
 June            ... Every June 1st.  Jun. 15\fB\et\fRJune 15.
 15 *            ... 15th of every month.  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  .Ed
 .Sh FILES  .Sh FILES
 The following default calendar files are provided:  .Bl -tag -width ~/.calendar/calendar -compact
 .Pp  .It Pa calendar
 .Bl -tag -width calendar.christian -compact  File in current directory.
   .It Pa ~/.calendar
   Directory in the user's home directory (which
   .Nm
   changes 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.all
   International and national calendar files.
 .It Pa calendar.birthday  .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.canada
   Canadian holidays.
 .It Pa calendar.christian  .It Pa calendar.christian
 Christian holidays.  Christian holidays (should be updated yearly by the local system administrator
 This calendar should be updated yearly by the local system administrator  so that roving holidays are set correctly for the current year).
 so that roving holidays are set correctly for the current year.  
 .It Pa calendar.computer  .It Pa calendar.computer
 Days of special significance to computer people.  Days of special significance to computer people.
   .It Pa calendar.croatian
   Croatian calendar.
   .It Pa calendar.discord
   Discordian calendar (all rites reversed).
   .It Pa calendar.fictional
   Fantasy and fiction dates (mostly LOTR).
   .It Pa calendar.french
   French calendar.
   .It Pa calendar.german
   German calendar.
 .It Pa calendar.history  .It Pa calendar.history
 Everything  else,  mostly  U. S. historical events.  Miscellaneous history.
 .It Pa calendar.holiday  .It Pa calendar.holiday
 Other  holidays,  including  the  not-well-known,  obscure, and  Other holidays (including the not-well-known, obscure, and
 .Em really  .Em really
 obscure.  obscure).
 .It Pa calendar.judaic  .It Pa calendar.judaic
 Jewish holidays.  Jewish holidays (should be updated yearly by the local system administrator
 This calendar should be updated yearly by the local system administrator  so that roving holidays are set correctly for the current year).
 so that roving holidays are set correctly for the current year.  
 .It Pa calendar.music  .It Pa calendar.music
 Musical  events,  births, and deaths.  Musical events, births, and deaths (strongly oriented toward rock n' roll).
 Strongly  oriented  toward  rock 'n' roll.  .It Pa calendar.openbsd
   .Ox
   related events.
   .It Pa calendar.pagan
   Pagan holidays, celebrations and festivals.
   .It Pa calendar.russian
   Russian calendar.
   .It Pa calendar.space
   Cosmic history.
   .It Pa calendar.ushistory
   U.S. history.
 .It Pa calendar.usholiday  .It Pa calendar.usholiday
 U.S. holidays.  U.S. holidays.
 This calendar should be updated yearly by the local system administrator  .It Pa calendar.world
 so that roving holidays are set correctly for the current year.  World wide calendar.
 .El  .El
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr at 1 ,  .Xr at 1 ,
   .Xr cal 1 ,
 .Xr cpp 1 ,  .Xr cpp 1 ,
   .Xr mail 1 ,
 .Xr cron 8  .Xr cron 8
 .Sh COMPATIBILITY  .Sh STANDARDS
 The  The
 .Nm calendar  .Nm
 program previously selected lines which had the correct date anywhere  program previously selected lines which had the correct date anywhere
 in the line.  in the line.
 This is no longer true, the date is only recognized when it occurs  This is no longer true: the date is only recognized when it occurs
 first on the line.  at the beginning of a line.
 .Sh HISTORY  .Sh HISTORY
 A  A
 .Nm  .Nm
 command appeared in  command appeared in
 .At v7 .  .At v7 .
 .Sh BUGS  .Sh BUGS
 .Nm Calendar  .Nm
 doesn't handle events that move around from year to year, i.e.,  doesn't handle all Jewish holidays or moon phases.
 ``the last Monday in April''.  

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.40