Commit | Line | Data |
---|---|---|
b5dc1377 | 1 | .\" Copyright (c) 1989, 1990 The Regents of the University of California. |
f85e7486 KB |
2 | .\" All rights reserved. |
3 | .\" | |
b5dc1377 | 4 | .\" %sccs.include.redist.man% |
f85e7486 | 5 | .\" |
b5dc1377 | 6 | .\" @(#)calendar.1 6.8 (Berkeley) %G% |
0edeeecc | 7 | .\" |
b5dc1377 CL |
8 | .Dd |
9 | .\" | |
10 | .Dt CALENDAR 1 | |
11 | .Os BSD 4.4 | |
12 | .Sh NAME | |
13 | .Nm calendar | |
14 | .Nd reminder service | |
15 | .Sh SYNOPSIS | |
16 | .Nm calendar | |
17 | .Op \-a | |
18 | .Sh DESCRIPTION | |
19 | .Nm Calendar | |
20 | checks the current directory for a file named named | |
21 | .Li calendar | |
22 | and displays lines that begin with either today's date | |
23 | or tomorrow's. | |
f85e7486 | 24 | On Fridays, events on Friday through Monday are displayed. |
b5dc1377 | 25 | .Pp |
f85e7486 | 26 | The following options are available: |
b5dc1377 | 27 | .Tp Fl a |
f85e7486 KB |
28 | Process the ``calendar'' files of all users and mail the results |
29 | to them. | |
30 | This requires super-user privileges. | |
b5dc1377 CL |
31 | .Tp |
32 | .Pp | |
f85e7486 KB |
33 | A month and day should begin lines. |
34 | They may be entered in almost any format, either numeric or as character | |
35 | strings. | |
36 | A single asterisk (``*'') matches every month. | |
37 | A day without a month matches that day of every week. | |
38 | A month without a day matches the first of that month. | |
39 | Two numbers default to the month followed by the day. | |
49ada5ac | 40 | Lines with leading tabs default to the last entered date, allowing |
f85e7486 KB |
41 | multiple line specifications for a single date. |
42 | By convention, dates followed by an asterisk are not fixed, i.e. change | |
43 | from year to year. | |
b5dc1377 | 44 | .Pp |
f85e7486 | 45 | The ``calendar'' file is preprocessed by |
b5dc1377 | 46 | .Xr cpp 1 , |
f85e7486 KB |
47 | allowing the inclusion of shared files such as company holidays or |
48 | meetings. | |
49 | If the shared file is not referenced by a full pathname, | |
b5dc1377 | 50 | .Xr cpp 1 |
f85e7486 KB |
51 | searches in the current (or home) directory first, and then in the |
52 | directory | |
b5dc1377 | 53 | .Pa /usr/share/calendar . |
f85e7486 KB |
54 | Empty lines and lines protected by the C commenting syntax (/* ... */) |
55 | are ignored. | |
b5dc1377 | 56 | .Pp |
f85e7486 | 57 | Some possible calendar entries: |
b5dc1377 CL |
58 | .Pp |
59 | .Ds I | |
f85e7486 KB |
60 | #include <calendar.usholiday> |
61 | #include <calendar.birthday> | |
b5dc1377 | 62 | |
f93a9a69 | 63 | 6/15 ... June 15 (if ambiguous, will default to month/day). |
f85e7486 KB |
64 | Jun. 15 ... June 15. |
65 | 15 June ... June 15. | |
66 | Thursday ... Every Thursday. | |
67 | June ... Every June 1st. | |
68 | 15 * ... 15th of every month. | |
b5dc1377 CL |
69 | .De |
70 | .Pp | |
71 | .Sh FILES | |
f85e7486 | 72 | The following default calendar files are provided: |
b5dc1377 CL |
73 | .Dw calendar.christian |
74 | .Ds L | |
75 | .Dp Pa calendar.birthday | |
76 | Births and deaths of famous ( and not- so- famous) people. | |
77 | .Dp Pa calendar.christian | |
4f0b6db5 | 78 | Christian holidays. |
f85e7486 KB |
79 | This calendar should be updated yearly by the local system administrator |
80 | so that roving holidays are set correctly for the current year. | |
b5dc1377 | 81 | .Dp Pa calendar.computer |
c5bc05d7 | 82 | Days of special significance to computer people. |
b5dc1377 CL |
83 | .Dp Pa calendar.history |
84 | Everything else, mostly U. S. historical events. | |
85 | .Dp Pa calendar.holiday | |
86 | Other holidays, including the not-well-known, obscure, and | |
87 | .Em really | |
f85e7486 | 88 | obscure. |
b5dc1377 | 89 | .Dp Pa calendar.judaic |
4f0b6db5 KB |
90 | Jewish holidays. |
91 | This calendar should be updated yearly by the local system administrator | |
92 | so that roving holidays are set correctly for the current year. | |
b5dc1377 CL |
93 | .Dp Pa calendar.music |
94 | Musical events, births, and deaths. | |
95 | Strongly oriented toward rock ' n' roll. | |
96 | .Dp Pa calendar.usholiday | |
4f0b6db5 KB |
97 | U.S. holidays. |
98 | This calendar should be updated yearly by the local system administrator | |
99 | so that roving holidays are set correctly for the current year. | |
b5dc1377 CL |
100 | .Dp |
101 | .Sh SEE ALSO | |
102 | .Xr at 1 , | |
103 | .Xr cpp 1 , | |
104 | .Xr cron 8 | |
105 | .Xr mail 1 , | |
106 | .Sh COMPATIBILITY | |
71fb7577 | 107 | The |
b5dc1377 | 108 | .Nm calendar |
71fb7577 KB |
109 | program previously selected lines which had the correct date anywhere |
110 | in the line. | |
111 | This is no longer true, the date is only recognized when it occurs | |
112 | first on the line. | |
b5dc1377 CL |
113 | .Sh HISTORY |
114 | A | |
115 | .Nm | |
116 | command appeared in Version 7 AT&T UNIX. | |
117 | The version of | |
118 | .Nm calendar | |
119 | released with this man page | |
120 | is not derived from the AT&T version. | |
121 | .\" what is status of code?? are phrases like today's date a problem? | |
122 | .\" todays's and tomorrow' are only AT&T similarities | |
123 | .Sh BUGS | |
124 | .Nm Calendar | |
f85e7486 KB |
125 | doesn't handle events that move around from year to year, i.e. |
126 | ``the last Monday in April''. |