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