Commit | Line | Data |
---|---|---|
4a944828 WJ |
1 | .\" Copyright (c) 1989, 1990 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
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. | |
19 | .\" | |
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. | |
31 | .\" | |
32 | .\" @(#)calendar.1 6.13 (Berkeley) 6/17/91 | |
33 | .\" | |
34 | .Dd June 17, 1991 | |
35 | .Dt CALENDAR 1 | |
36 | .Os | |
37 | .Sh NAME | |
38 | .Nm calendar | |
39 | .Nd reminder service | |
40 | .Sh SYNOPSIS | |
41 | .Nm calendar | |
42 | .Op Fl a | |
43 | .Sh DESCRIPTION | |
44 | .Nm Calendar | |
45 | checks the current directory for a file named named | |
46 | .Pa calendar | |
47 | and displays lines that begin with either today's date | |
48 | or tomorrow's. | |
49 | On Fridays, events on Friday through Monday are displayed. | |
50 | .Pp | |
51 | The following options are available: | |
52 | .Bl -tag -width Ds | |
53 | .It Fl a | |
54 | Process the ``calendar'' files of all users and mail the results | |
55 | to them. | |
56 | This requires super-user privileges. | |
57 | .El | |
58 | .Pp | |
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. | |
66 | Lines with leading tabs default to the last entered date, allowing | |
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. | |
70 | .Pp | |
71 | The ``calendar'' file is preprocessed by | |
72 | .Xr cpp 1 , | |
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, | |
76 | .Xr cpp 1 | |
77 | searches in the current (or home) directory first, and then in the | |
78 | directory | |
79 | .Pa /usr/share/calendar . | |
80 | Empty lines and lines protected by the C commenting syntax | |
81 | .Pq Li /* ... */ | |
82 | are ignored. | |
83 | .Pp | |
84 | Some possible calendar entries: | |
85 | .Bd -unfilled -offset indent | |
86 | #include <calendar.usholiday> | |
87 | #include <calendar.birthday> | |
88 | ||
89 | 6/15 ... June 15 (if ambiguous, will default to month/day). | |
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. | |
95 | .Ed | |
96 | .Sh FILES | |
97 | The following default calendar files are provided: | |
98 | .Pp | |
99 | .Bl -tag -width calendar.christian -compact | |
100 | .It Pa calendar.birthday | |
101 | Births and deaths of famous (and not-so-famous) people. | |
102 | .It Pa calendar.christian | |
103 | Christian holidays. | |
104 | This calendar should be updated yearly by the local system administrator | |
105 | so that roving holidays are set correctly for the current year. | |
106 | .It Pa calendar.computer | |
107 | Days of special significance to computer people. | |
108 | .It Pa calendar.history | |
109 | Everything else, mostly U. S. historical events. | |
110 | .It Pa calendar.holiday | |
111 | Other holidays, including the not-well-known, obscure, and | |
112 | .Em really | |
113 | obscure. | |
114 | .It Pa calendar.judaic | |
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. | |
118 | .It Pa calendar.music | |
119 | Musical events, births, and deaths. | |
120 | Strongly oriented toward rock 'n' roll. | |
121 | .It Pa calendar.usholiday | |
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. | |
125 | .El | |
126 | .Sh SEE ALSO | |
127 | .Xr at 1 , | |
128 | .Xr cpp 1 , | |
129 | .Xr cron 8 | |
130 | .Xr mail 1 , | |
131 | .Sh COMPATIBILITY | |
132 | The | |
133 | .Nm calendar | |
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. | |
138 | .Sh HISTORY | |
139 | A | |
140 | .Nm | |
141 | command appeared in Version 7 AT&T UNIX. | |
142 | .Sh BUGS | |
143 | .Nm Calendar | |
144 | doesn't handle events that move around from year to year, i.e. | |
145 | ``the last Monday in April''. |