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