Annotation of src/usr.bin/calendar/calendar.1, Revision 1.26
1.26 ! mickey 1: .\" $OpenBSD: calendar.1,v 1.25 2004/02/09 20:48:39 jmc Exp $
1.1 deraadt 2: .\"
3: .\" Copyright (c) 1989, 1990, 1993
1.3 millert 4: .\" The Regents of the University of California. All rights reserved.
1.1 deraadt 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.
1.22 millert 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 15: .\" may be used to endorse or promote products derived from this software
16: .\" without specific prior written permission.
17: .\"
18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28: .\" SUCH DAMAGE.
29: .\"
1.3 millert 30: .\" @(#)calendar.1 8.1 (Berkeley) 6/29/93
1.1 deraadt 31: .\"
32: .Dd June 29, 1993
33: .Dt CALENDAR 1
34: .Os
35: .Sh NAME
36: .Nm calendar
37: .Nd reminder service
38: .Sh SYNOPSIS
1.10 aaron 39: .Nm calendar
1.24 jmc 40: .Op Fl ab
1.3 millert 41: .Op Fl A Ar num
42: .Op Fl B Ar num
1.15 mickey 43: .Op Fl f Ar calendarfile
1.7 millert 44: .Op Fl t Ar [[[cc]yy][mm]]dd
1.1 deraadt 45: .Sh DESCRIPTION
1.3 millert 46: The
1.9 pjanzen 47: .Nm
1.1 deraadt 48: utility checks the current directory or the directory specified by the
1.5 aaron 49: .Ev CALENDAR_DIR
1.1 deraadt 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
1.12 aaron 56: The options are as follows:
1.1 deraadt 57: .Bl -tag -width Ds
1.25 jmc 58: .It Fl A Ar num
59: Print lines from today and next
60: .Ar num
61: days (forward, future).
1.1 deraadt 62: .It Fl a
1.9 pjanzen 63: Process the
64: .Dq calendar
65: files of all users and mail the results
1.1 deraadt 66: to them.
1.14 aaron 67: This requires superuser privileges.
1.3 millert 68: .It Fl B Ar num
1.5 aaron 69: Print lines from today and previous
1.3 millert 70: .Ar num
1.5 aaron 71: days (backward, past).
1.25 jmc 72: .It Fl b
73: Enforce special date calculation mode for KOI8 calendars.
1.3 millert 74: .It Fl f Pa calendarfile
1.5 aaron 75: Use
1.3 millert 76: .Pa calendarfile
1.5 aaron 77: as the default calendar file.
1.7 millert 78: .It Fl t Ar [[[cc]yy][mm]]dd
1.9 pjanzen 79: Act like the specified value is
80: .Dq today
81: instead of using the current date.
1.1 deraadt 82: .El
83: .Pp
1.3 millert 84: To handle calendars in your national code table you can specify
85: .Dq LANG=<locale_name>
1.13 aaron 86: in the calendar file as early as possible.
87: To handle national Easter names in the calendars,
1.3 millert 88: .Dq Easter=<national_name>
89: (for Catholic Easter) or
90: .Dq Paskha=<national_name>
91: (for Orthodox Easter) can be used.
1.26 ! mickey 92: .Pp
! 93: .Dq CALENDAR
! 94: variable can be used to specify the style.
! 95: Only
! 96: .Sq Julian
! 97: and
! 98: .Sq Gregorian
! 99: styles are currently supported.
! 100: Use
! 101: .Dq CALENDAR=
! 102: to return to the default (Gregorian).
1.16 mickey 103: .Pp
104: To enforce special date calculation mode for Cyrillic calendars
105: you should specify
106: .Dq LANG=<local_name>
107: and
1.17 mickey 108: .Dq BODUN=<bodun_prefix>
109: where <local_name> can be ru_RU.KOI8-R, uk_UA.KOI8-U or by_BY.KOI8-B.
1.3 millert 110: .Pp
111: Other lines should begin with a month and day.
1.1 deraadt 112: They may be entered in almost any format, either numeric or as character
113: strings.
1.3 millert 114: If proper locale is set, national months and weekdays
115: names can be used.
1.5 aaron 116: A single asterisk (`*') matches every month.
1.1 deraadt 117: A day without a month matches that day of every week.
118: A month without a day matches the first of that month.
119: Two numbers default to the month followed by the day.
120: Lines with leading tabs default to the last entered date, allowing
121: multiple line specifications for a single date.
1.9 pjanzen 122: .Dq Easter
123: (may be followed by a positive or negative integer) is Easter for this year.
124: .Dq Paskha
125: (may be followed by a positive or negative integer) is
1.3 millert 126: Orthodox Easter for this year.
1.9 pjanzen 127: Weekdays may be followed by
128: .Dq -4
129: .Li ...
130: .Dq +5
131: (aliases last, first, second, third, fourth) for moving events like
132: .Dq the last Monday in April .
1.3 millert 133: .Pp
1.5 aaron 134: By convention, dates followed by an asterisk
135: .Pq Sq *
136: are not fixed, i.e., change
1.1 deraadt 137: from year to year.
138: .Pp
1.5 aaron 139: Day descriptions start after the first <tab> character in the line;
140: if the line does not contain a <tab> character, it isn't printed out.
141: If the first character in the line is a <tab> character, it is treated as
1.8 pjanzen 142: the continuation of the previous description.
1.3 millert 143: .Pp
1.9 pjanzen 144: The calendar file is preprocessed by
1.1 deraadt 145: .Xr cpp 1 ,
146: allowing the inclusion of shared files such as company holidays or
147: meetings.
148: If the shared file is not referenced by a full pathname,
149: .Xr cpp 1
150: searches in the current (or home) directory first, and then in the
151: directory
152: .Pa /usr/share/calendar .
153: Empty lines and lines protected by the C commenting syntax
154: .Pq Li /* ... */
155: are ignored.
156: .Pp
1.5 aaron 157: Some possible calendar entries (<tab> characters are highlighted by a
158: \fB\et\fR sequence):
1.1 deraadt 159: .Bd -unfilled -offset indent
1.3 millert 160: LANG=C
161: Easter=Ostern
162:
163: #include <calendar.usholiday>
164: #include <calendar.birthday>
165:
166: 6/15\fB\et\fRJune 15 (if ambiguous, will default to month/day).
167: Jun. 15\fB\et\fRJune 15.
168: 15 June\fB\et\fRJune 15.
169: Thursday\fB\et\fREvery Thursday.
170: June\fB\et\fREvery June 1st.
171: 15 *\fB\et\fR15th of every month.
1.1 deraadt 172:
1.3 millert 173: May Sun+2\fB\et\fRsecond Sunday in May (Muttertag)
174: 04/SunLast\fB\et\fRlast Sunday in April,
175: \fB\et\fRsummer time in Europe
176: Easter\fB\et\fREaster
177: Ostern-2\fB\et\fRGood Friday (2 days before Easter)
178: Paskha\fB\et\fROrthodox Easter
1.1 deraadt 179: .Ed
180: .Sh FILES
1.5 aaron 181: .Bl -tag -width ~/.calendar/calendar -compact
1.3 millert 182: .It Pa calendar
1.25 jmc 183: File in current directory.
1.3 millert 184: .It Pa ~/.calendar
1.25 jmc 185: Directory in the user's home directory (which
1.9 pjanzen 186: .Nm
1.25 jmc 187: changes into, if it exists).
1.3 millert 188: .It Pa ~/.calendar/calendar
1.25 jmc 189: File to use if no calendar file exists in the current directory.
1.3 millert 190: .It Pa ~/.calendar/nomail
1.9 pjanzen 191: .Nm
1.25 jmc 192: will not send mail if this file exists.
1.1 deraadt 193: .It Pa calendar.birthday
1.25 jmc 194: Births and deaths of famous (and not-so-famous) people.
1.1 deraadt 195: .It Pa calendar.christian
1.8 pjanzen 196: Christian holidays (should be updated yearly by the local system administrator
1.25 jmc 197: so that roving holidays are set correctly for the current year).
1.1 deraadt 198: .It Pa calendar.computer
1.25 jmc 199: Days of special significance to computer people.
200: .It Pa calendar.croatian
201: Croatian calendar.
1.18 mickey 202: .It Pa calendar.fictional
1.25 jmc 203: Fantasy and fiction dates (mostly LOTR).
204: .It Pa calendar.french
205: French calendar.
206: .It Pa calendar.german
207: German calendar.
1.1 deraadt 208: .It Pa calendar.history
1.25 jmc 209: Everything else, mostly U.S. historical events.
1.1 deraadt 210: .It Pa calendar.holiday
1.25 jmc 211: Other holidays (including the not-well-known, obscure, and
1.1 deraadt 212: .Em really
1.25 jmc 213: obscure).
1.1 deraadt 214: .It Pa calendar.judaic
1.5 aaron 215: Jewish holidays (should be updated yearly by the local system administrator
1.25 jmc 216: so that roving holidays are set correctly for the current year).
1.1 deraadt 217: .It Pa calendar.music
1.25 jmc 218: Musical events, births, and deaths (strongly oriented toward rock n' roll).
1.19 fgsch 219: .It Pa calendar.openbsd
220: .Ox
1.25 jmc 221: related events.
1.18 mickey 222: .It Pa calendar.pagan
1.25 jmc 223: Pagan holidays, celebrations and festivals.
224: .It Pa calendar.russian
225: Russian calendar.
1.1 deraadt 226: .It Pa calendar.usholiday
1.25 jmc 227: U.S. holidays.
1.18 mickey 228: .It Pa calendar.world
1.25 jmc 229: World wide calendar.
1.1 deraadt 230: .El
231: .Sh SEE ALSO
232: .Xr at 1 ,
1.12 aaron 233: .Xr cal 1 ,
1.1 deraadt 234: .Xr cpp 1 ,
1.5 aaron 235: .Xr mail 1 ,
236: .Xr cron 8
1.23 jmc 237: .Sh STANDARDS
1.1 deraadt 238: The
1.11 aaron 239: .Nm
1.1 deraadt 240: program previously selected lines which had the correct date anywhere
241: in the line.
1.12 aaron 242: This is no longer true: the date is only recognized when it occurs
1.3 millert 243: at the beginning of a line.
1.1 deraadt 244: .Sh HISTORY
245: A
246: .Nm
1.3 millert 247: command appeared in
1.1 deraadt 248: .At v7 .
249: .Sh BUGS
1.9 pjanzen 250: .Nm
1.5 aaron 251: doesn't handle Jewish holidays or moon phases.
![[BACK]](/icons/back.gif){kind=icon}
Return to calendar.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / calendar