annotate man/calendar.texi @ 89816:b2658475cebf

(all): Rename target from charsets. Depend on ${TRANS_TABLE} (CNS-2.map, CNS-3.map, CNS-4.map, CNS-5.map, CNS-6.map) (CNS-7.map): Generate from cns2ucsdkw.txt. (install): Copy updated files only.
author Kenichi Handa <handa@m17n.org>
date Thu, 12 Feb 2004 07:48:24 +0000
parents 375f2633d815
children 68c22ea6027c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 @c This is part of the Emacs manual.
39287
3b40423b9355 Update the copyright years.
Eli Zaretskii <eliz@gnu.org>
parents: 38870
diff changeset
2 @c Copyright (C) 1985,86,87,93,94,95,1997,2000,2001 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @c See file emacs.texi for copying conditions.
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @node Calendar/Diary, Gnus, Dired, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @chapter The Calendar and the Diary
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @cindex calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @findex calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
8
Dave Love <fx@gnu.org>
parents:
diff changeset
9 Emacs provides the functions of a desk calendar, with a diary of
36145
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
10 planned or past events. It also has facilities for managing your
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
11 appointments, and keeping track of how much time you spend working on
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
12 certain projects.
30794
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
13
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
14 To enter the calendar, type @kbd{M-x calendar}; this displays a
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
15 three-month calendar centered on the current month, with point on the
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
16 current date. With a numeric argument, as in @kbd{C-u M-x calendar}, it
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
17 prompts you for the month and year to be the center of the three-month
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
18 calendar. The calendar uses its own buffer, whose major mode is
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
19 Calendar mode.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
20
Dave Love <fx@gnu.org>
parents:
diff changeset
21 @kbd{Mouse-2} in the calendar brings up a menu of operations on a
Dave Love <fx@gnu.org>
parents:
diff changeset
22 particular date; @kbd{C-Mouse-3} brings up a menu of commonly used
Dave Love <fx@gnu.org>
parents:
diff changeset
23 calendar features that are independent of any particular date. To exit
Dave Love <fx@gnu.org>
parents:
diff changeset
24 the calendar, type @kbd{q}. @xref{Calendar, Customizing the Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
25 and Diary,, elisp, The Emacs Lisp Reference Manual}, for customization
Dave Love <fx@gnu.org>
parents:
diff changeset
26 information about the calendar and diary.
Dave Love <fx@gnu.org>
parents:
diff changeset
27
Dave Love <fx@gnu.org>
parents:
diff changeset
28 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
29 * Calendar Motion:: Moving through the calendar; selecting a date.
Dave Love <fx@gnu.org>
parents:
diff changeset
30 * Scroll Calendar:: Bringing earlier or later months onto the screen.
Dave Love <fx@gnu.org>
parents:
diff changeset
31 * Counting Days:: How many days are there between two dates?
Dave Love <fx@gnu.org>
parents:
diff changeset
32 * General Calendar:: Exiting or recomputing the calendar.
Dave Love <fx@gnu.org>
parents:
diff changeset
33 * LaTeX Calendar:: Print a calendar using LaTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
34 * Holidays:: Displaying dates of holidays.
Dave Love <fx@gnu.org>
parents:
diff changeset
35 * Sunrise/Sunset:: Displaying local times of sunrise and sunset.
Dave Love <fx@gnu.org>
parents:
diff changeset
36 * Lunar Phases:: Displaying phases of the moon.
Dave Love <fx@gnu.org>
parents:
diff changeset
37 * Other Calendars:: Converting dates to other calendar systems.
Dave Love <fx@gnu.org>
parents:
diff changeset
38 * Diary:: Displaying events from your diary.
Dave Love <fx@gnu.org>
parents:
diff changeset
39 * Appointments:: Reminders when it's time to do something.
Dave Love <fx@gnu.org>
parents:
diff changeset
40 * Daylight Savings:: How to specify when daylight savings time is active.
30794
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
41 * Time Intervals:: Keeping track of time intervals.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
42 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
43
Dave Love <fx@gnu.org>
parents:
diff changeset
44 @node Calendar Motion
Dave Love <fx@gnu.org>
parents:
diff changeset
45 @section Movement in the Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
46
Dave Love <fx@gnu.org>
parents:
diff changeset
47 @cindex moving inside the calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
48 Calendar mode lets you move through the calendar in logical units of
Dave Love <fx@gnu.org>
parents:
diff changeset
49 time such as days, weeks, months, and years. If you move outside the
Dave Love <fx@gnu.org>
parents:
diff changeset
50 three months originally displayed, the calendar display ``scrolls''
Dave Love <fx@gnu.org>
parents:
diff changeset
51 automatically through time to make the selected date visible. Moving to
Dave Love <fx@gnu.org>
parents:
diff changeset
52 a date lets you view its holidays or diary entries, or convert it to other
Dave Love <fx@gnu.org>
parents:
diff changeset
53 calendars; moving longer time periods is also useful simply to scroll the
Dave Love <fx@gnu.org>
parents:
diff changeset
54 calendar.
Dave Love <fx@gnu.org>
parents:
diff changeset
55
Dave Love <fx@gnu.org>
parents:
diff changeset
56 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
57 * Calendar Unit Motion:: Moving by days, weeks, months, and years.
Dave Love <fx@gnu.org>
parents:
diff changeset
58 * Move to Beginning or End:: Moving to start/end of weeks, months, and years.
Dave Love <fx@gnu.org>
parents:
diff changeset
59 * Specified Dates:: Moving to the current date or another
Dave Love <fx@gnu.org>
parents:
diff changeset
60 specific date.
Dave Love <fx@gnu.org>
parents:
diff changeset
61 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
62
Dave Love <fx@gnu.org>
parents:
diff changeset
63 @node Calendar Unit Motion
Dave Love <fx@gnu.org>
parents:
diff changeset
64 @subsection Motion by Standard Lengths of Time
Dave Love <fx@gnu.org>
parents:
diff changeset
65
Dave Love <fx@gnu.org>
parents:
diff changeset
66 The commands for movement in the calendar buffer parallel the
Dave Love <fx@gnu.org>
parents:
diff changeset
67 commands for movement in text. You can move forward and backward by
Dave Love <fx@gnu.org>
parents:
diff changeset
68 days, weeks, months, and years.
Dave Love <fx@gnu.org>
parents:
diff changeset
69
Dave Love <fx@gnu.org>
parents:
diff changeset
70 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
71 @item C-f
Dave Love <fx@gnu.org>
parents:
diff changeset
72 Move point one day forward (@code{calendar-forward-day}).
Dave Love <fx@gnu.org>
parents:
diff changeset
73 @item C-b
Dave Love <fx@gnu.org>
parents:
diff changeset
74 Move point one day backward (@code{calendar-backward-day}).
Dave Love <fx@gnu.org>
parents:
diff changeset
75 @item C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
76 Move point one week forward (@code{calendar-forward-week}).
Dave Love <fx@gnu.org>
parents:
diff changeset
77 @item C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
78 Move point one week backward (@code{calendar-backward-week}).
Dave Love <fx@gnu.org>
parents:
diff changeset
79 @item M-@}
Dave Love <fx@gnu.org>
parents:
diff changeset
80 Move point one month forward (@code{calendar-forward-month}).
Dave Love <fx@gnu.org>
parents:
diff changeset
81 @item M-@{
Dave Love <fx@gnu.org>
parents:
diff changeset
82 Move point one month backward (@code{calendar-backward-month}).
Dave Love <fx@gnu.org>
parents:
diff changeset
83 @item C-x ]
Dave Love <fx@gnu.org>
parents:
diff changeset
84 Move point one year forward (@code{calendar-forward-year}).
Dave Love <fx@gnu.org>
parents:
diff changeset
85 @item C-x [
Dave Love <fx@gnu.org>
parents:
diff changeset
86 Move point one year backward (@code{calendar-backward-year}).
Dave Love <fx@gnu.org>
parents:
diff changeset
87 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
88
Dave Love <fx@gnu.org>
parents:
diff changeset
89 @kindex C-f @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
90 @findex calendar-forward-day
Dave Love <fx@gnu.org>
parents:
diff changeset
91 @kindex C-b @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
92 @findex calendar-backward-day
Dave Love <fx@gnu.org>
parents:
diff changeset
93 @kindex C-n @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
94 @findex calendar-forward-week
Dave Love <fx@gnu.org>
parents:
diff changeset
95 @kindex C-p @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
96 @findex calendar-backward-week
Dave Love <fx@gnu.org>
parents:
diff changeset
97 The day and week commands are natural analogues of the usual Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
98 commands for moving by characters and by lines. Just as @kbd{C-n}
Dave Love <fx@gnu.org>
parents:
diff changeset
99 usually moves to the same column in the following line, in Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
100 mode it moves to the same day in the following week. And @kbd{C-p}
Dave Love <fx@gnu.org>
parents:
diff changeset
101 moves to the same day in the previous week.
Dave Love <fx@gnu.org>
parents:
diff changeset
102
Dave Love <fx@gnu.org>
parents:
diff changeset
103 The arrow keys are equivalent to @kbd{C-f}, @kbd{C-b}, @kbd{C-n} and
Dave Love <fx@gnu.org>
parents:
diff changeset
104 @kbd{C-p}, just as they normally are in other modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
105
Dave Love <fx@gnu.org>
parents:
diff changeset
106 @kindex M-@} @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
107 @findex calendar-forward-month
Dave Love <fx@gnu.org>
parents:
diff changeset
108 @kindex M-@{ @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
109 @findex calendar-backward-month
Dave Love <fx@gnu.org>
parents:
diff changeset
110 @kindex C-x ] @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
111 @findex calendar-forward-year
Dave Love <fx@gnu.org>
parents:
diff changeset
112 @kindex C-x [ @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
113 @findex calendar-forward-year
Dave Love <fx@gnu.org>
parents:
diff changeset
114 The commands for motion by months and years work like those for
Dave Love <fx@gnu.org>
parents:
diff changeset
115 weeks, but move a larger distance. The month commands @kbd{M-@}} and
Dave Love <fx@gnu.org>
parents:
diff changeset
116 @kbd{M-@{} move forward or backward by an entire month's time. The
Dave Love <fx@gnu.org>
parents:
diff changeset
117 year commands @kbd{C-x ]} and @w{@kbd{C-x [}} move forward or backward a
Dave Love <fx@gnu.org>
parents:
diff changeset
118 whole year.
Dave Love <fx@gnu.org>
parents:
diff changeset
119
Dave Love <fx@gnu.org>
parents:
diff changeset
120 The easiest way to remember these commands is to consider months and
Dave Love <fx@gnu.org>
parents:
diff changeset
121 years analogous to paragraphs and pages of text, respectively. But the
Dave Love <fx@gnu.org>
parents:
diff changeset
122 commands themselves are not quite analogous. The ordinary Emacs paragraph
Dave Love <fx@gnu.org>
parents:
diff changeset
123 commands move to the beginning or end of a paragraph, whereas these month
Dave Love <fx@gnu.org>
parents:
diff changeset
124 and year commands move by an entire month or an entire year, which usually
Dave Love <fx@gnu.org>
parents:
diff changeset
125 involves skipping across the end of a month or year.
Dave Love <fx@gnu.org>
parents:
diff changeset
126
Dave Love <fx@gnu.org>
parents:
diff changeset
127 All these commands accept a numeric argument as a repeat count.
Dave Love <fx@gnu.org>
parents:
diff changeset
128 For convenience, the digit keys and the minus sign specify numeric
Dave Love <fx@gnu.org>
parents:
diff changeset
129 arguments in Calendar mode even without the Meta modifier. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
130 @kbd{100 C-f} moves point 100 days forward from its present location.
Dave Love <fx@gnu.org>
parents:
diff changeset
131
Dave Love <fx@gnu.org>
parents:
diff changeset
132 @node Move to Beginning or End
Dave Love <fx@gnu.org>
parents:
diff changeset
133 @subsection Beginning or End of Week, Month or Year
Dave Love <fx@gnu.org>
parents:
diff changeset
134
Dave Love <fx@gnu.org>
parents:
diff changeset
135 A week (or month, or year) is not just a quantity of days; we think of
Dave Love <fx@gnu.org>
parents:
diff changeset
136 weeks (months, years) as starting on particular dates. So Calendar mode
Dave Love <fx@gnu.org>
parents:
diff changeset
137 provides commands to move to the beginning or end of a week, month or
Dave Love <fx@gnu.org>
parents:
diff changeset
138 year:
Dave Love <fx@gnu.org>
parents:
diff changeset
139
Dave Love <fx@gnu.org>
parents:
diff changeset
140 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
141 @kindex C-a @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
142 @findex calendar-beginning-of-week
Dave Love <fx@gnu.org>
parents:
diff changeset
143 @item C-a
Dave Love <fx@gnu.org>
parents:
diff changeset
144 Move point to start of week (@code{calendar-beginning-of-week}).
Dave Love <fx@gnu.org>
parents:
diff changeset
145 @kindex C-e @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
146 @findex calendar-end-of-week
Dave Love <fx@gnu.org>
parents:
diff changeset
147 @item C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
148 Move point to end of week (@code{calendar-end-of-week}).
Dave Love <fx@gnu.org>
parents:
diff changeset
149 @kindex M-a @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
150 @findex calendar-beginning-of-month
Dave Love <fx@gnu.org>
parents:
diff changeset
151 @item M-a
Dave Love <fx@gnu.org>
parents:
diff changeset
152 Move point to start of month (@code{calendar-beginning-of-month}).
Dave Love <fx@gnu.org>
parents:
diff changeset
153 @kindex M-e @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
154 @findex calendar-end-of-month
Dave Love <fx@gnu.org>
parents:
diff changeset
155 @item M-e
Dave Love <fx@gnu.org>
parents:
diff changeset
156 Move point to end of month (@code{calendar-end-of-month}).
Dave Love <fx@gnu.org>
parents:
diff changeset
157 @kindex M-< @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
158 @findex calendar-beginning-of-year
Dave Love <fx@gnu.org>
parents:
diff changeset
159 @item M-<
Dave Love <fx@gnu.org>
parents:
diff changeset
160 Move point to start of year (@code{calendar-beginning-of-year}).
Dave Love <fx@gnu.org>
parents:
diff changeset
161 @kindex M-> @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
162 @findex calendar-end-of-year
Dave Love <fx@gnu.org>
parents:
diff changeset
163 @item M->
Dave Love <fx@gnu.org>
parents:
diff changeset
164 Move point to end of year (@code{calendar-end-of-year}).
Dave Love <fx@gnu.org>
parents:
diff changeset
165 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
166
Dave Love <fx@gnu.org>
parents:
diff changeset
167 These commands also take numeric arguments as repeat counts, with the
Dave Love <fx@gnu.org>
parents:
diff changeset
168 repeat count indicating how many weeks, months, or years to move
Dave Love <fx@gnu.org>
parents:
diff changeset
169 backward or forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
170
Dave Love <fx@gnu.org>
parents:
diff changeset
171 @vindex calendar-week-start-day
Dave Love <fx@gnu.org>
parents:
diff changeset
172 @cindex weeks, which day they start on
Dave Love <fx@gnu.org>
parents:
diff changeset
173 @cindex calendar, first day of week
Dave Love <fx@gnu.org>
parents:
diff changeset
174 By default, weeks begin on Sunday. To make them begin on Monday
Dave Love <fx@gnu.org>
parents:
diff changeset
175 instead, set the variable @code{calendar-week-start-day} to 1.
Dave Love <fx@gnu.org>
parents:
diff changeset
176
Dave Love <fx@gnu.org>
parents:
diff changeset
177 @node Specified Dates
Dave Love <fx@gnu.org>
parents:
diff changeset
178 @subsection Specified Dates
Dave Love <fx@gnu.org>
parents:
diff changeset
179
Dave Love <fx@gnu.org>
parents:
diff changeset
180 Calendar mode provides commands for moving to a particular date
Dave Love <fx@gnu.org>
parents:
diff changeset
181 specified in various ways.
Dave Love <fx@gnu.org>
parents:
diff changeset
182
Dave Love <fx@gnu.org>
parents:
diff changeset
183 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
184 @item g d
Dave Love <fx@gnu.org>
parents:
diff changeset
185 Move point to specified date (@code{calendar-goto-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
186 @item o
Dave Love <fx@gnu.org>
parents:
diff changeset
187 Center calendar around specified month (@code{calendar-other-month}).
Dave Love <fx@gnu.org>
parents:
diff changeset
188 @item .
Dave Love <fx@gnu.org>
parents:
diff changeset
189 Move point to today's date (@code{calendar-goto-today}).
Dave Love <fx@gnu.org>
parents:
diff changeset
190 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
191
Dave Love <fx@gnu.org>
parents:
diff changeset
192 @kindex g d @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
193 @findex calendar-goto-date
Dave Love <fx@gnu.org>
parents:
diff changeset
194 @kbd{g d} (@code{calendar-goto-date}) prompts for a year, a month, and a day
Dave Love <fx@gnu.org>
parents:
diff changeset
195 of the month, and then moves to that date. Because the calendar includes all
Dave Love <fx@gnu.org>
parents:
diff changeset
196 dates from the beginning of the current era, you must type the year in its
Dave Love <fx@gnu.org>
parents:
diff changeset
197 entirety; that is, type @samp{1990}, not @samp{90}.
Dave Love <fx@gnu.org>
parents:
diff changeset
198
Dave Love <fx@gnu.org>
parents:
diff changeset
199 @kindex o @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
200 @findex calendar-other-month
Dave Love <fx@gnu.org>
parents:
diff changeset
201 @kbd{o} (@code{calendar-other-month}) prompts for a month and year,
Dave Love <fx@gnu.org>
parents:
diff changeset
202 then centers the three-month calendar around that month.
Dave Love <fx@gnu.org>
parents:
diff changeset
203
Dave Love <fx@gnu.org>
parents:
diff changeset
204 @kindex . @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
205 @findex calendar-goto-today
Dave Love <fx@gnu.org>
parents:
diff changeset
206 You can return to today's date with @kbd{.}@:
Dave Love <fx@gnu.org>
parents:
diff changeset
207 (@code{calendar-goto-today}).
Dave Love <fx@gnu.org>
parents:
diff changeset
208
Dave Love <fx@gnu.org>
parents:
diff changeset
209 @node Scroll Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
210 @section Scrolling in the Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
211
Dave Love <fx@gnu.org>
parents:
diff changeset
212 @cindex scrolling in the calendar
38745
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38156
diff changeset
213 The calendar display scrolls automatically through time when you
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38156
diff changeset
214 move out of the visible portion. You can also scroll it manually.
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38156
diff changeset
215 Imagine that the calendar window contains a long strip of paper with
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38156
diff changeset
216 the months on it. Scrolling the calendar means moving the strip
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38156
diff changeset
217 horizontally, so that new months become visible in the window.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
218
Dave Love <fx@gnu.org>
parents:
diff changeset
219 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
220 @item C-x <
Dave Love <fx@gnu.org>
parents:
diff changeset
221 Scroll calendar one month forward (@code{scroll-calendar-left}).
Dave Love <fx@gnu.org>
parents:
diff changeset
222 @item C-x >
Dave Love <fx@gnu.org>
parents:
diff changeset
223 Scroll calendar one month backward (@code{scroll-calendar-right}).
Dave Love <fx@gnu.org>
parents:
diff changeset
224 @item C-v
Dave Love <fx@gnu.org>
parents:
diff changeset
225 @itemx @key{NEXT}
Dave Love <fx@gnu.org>
parents:
diff changeset
226 Scroll calendar three months forward
Dave Love <fx@gnu.org>
parents:
diff changeset
227 (@code{scroll-calendar-left-three-months}).
Dave Love <fx@gnu.org>
parents:
diff changeset
228 @item M-v
Dave Love <fx@gnu.org>
parents:
diff changeset
229 @itemx @key{PRIOR}
Dave Love <fx@gnu.org>
parents:
diff changeset
230 Scroll calendar three months backward
Dave Love <fx@gnu.org>
parents:
diff changeset
231 (@code{scroll-calendar-right-three-months}).
Dave Love <fx@gnu.org>
parents:
diff changeset
232 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
233
Dave Love <fx@gnu.org>
parents:
diff changeset
234 @kindex C-x < @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
235 @findex scroll-calendar-left
Dave Love <fx@gnu.org>
parents:
diff changeset
236 @kindex C-x > @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
237 @findex scroll-calendar-right
Dave Love <fx@gnu.org>
parents:
diff changeset
238 The most basic calendar scroll commands scroll by one month at a
Dave Love <fx@gnu.org>
parents:
diff changeset
239 time. This means that there are two months of overlap between the
Dave Love <fx@gnu.org>
parents:
diff changeset
240 display before the command and the display after. @kbd{C-x <} scrolls
Dave Love <fx@gnu.org>
parents:
diff changeset
241 the calendar contents one month to the left; that is, it moves the
Dave Love <fx@gnu.org>
parents:
diff changeset
242 display forward in time. @kbd{C-x >} scrolls the contents to the
Dave Love <fx@gnu.org>
parents:
diff changeset
243 right, which moves backwards in time.
Dave Love <fx@gnu.org>
parents:
diff changeset
244
Dave Love <fx@gnu.org>
parents:
diff changeset
245 @kindex C-v @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
246 @findex scroll-calendar-left-three-months
Dave Love <fx@gnu.org>
parents:
diff changeset
247 @kindex M-v @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
248 @findex scroll-calendar-right-three-months
Dave Love <fx@gnu.org>
parents:
diff changeset
249 The commands @kbd{C-v} and @kbd{M-v} scroll the calendar by an entire
Dave Love <fx@gnu.org>
parents:
diff changeset
250 ``screenful''---three months---in analogy with the usual meaning of
Dave Love <fx@gnu.org>
parents:
diff changeset
251 these commands. @kbd{C-v} makes later dates visible and @kbd{M-v} makes
Dave Love <fx@gnu.org>
parents:
diff changeset
252 earlier dates visible. These commands take a numeric argument as a
Dave Love <fx@gnu.org>
parents:
diff changeset
253 repeat count; in particular, since @kbd{C-u} multiplies the next command
Dave Love <fx@gnu.org>
parents:
diff changeset
254 by four, typing @kbd{C-u C-v} scrolls the calendar forward by a year and
Dave Love <fx@gnu.org>
parents:
diff changeset
255 typing @kbd{C-u M-v} scrolls the calendar backward by a year.
Dave Love <fx@gnu.org>
parents:
diff changeset
256
Dave Love <fx@gnu.org>
parents:
diff changeset
257 The function keys @key{NEXT} and @key{PRIOR} are equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
258 @kbd{C-v} and @kbd{M-v}, just as they are in other modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
259
Dave Love <fx@gnu.org>
parents:
diff changeset
260 @node Counting Days
Dave Love <fx@gnu.org>
parents:
diff changeset
261 @section Counting Days
Dave Love <fx@gnu.org>
parents:
diff changeset
262
Dave Love <fx@gnu.org>
parents:
diff changeset
263 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
264 @item M-=
Dave Love <fx@gnu.org>
parents:
diff changeset
265 Display the number of days in the current region
Dave Love <fx@gnu.org>
parents:
diff changeset
266 (@code{calendar-count-days-region}).
Dave Love <fx@gnu.org>
parents:
diff changeset
267 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
268
Dave Love <fx@gnu.org>
parents:
diff changeset
269 @kindex M-= @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
270 @findex calendar-count-days-region
Dave Love <fx@gnu.org>
parents:
diff changeset
271 To determine the number of days in the region, type @kbd{M-=}
38870
d44abb4e68b2 Don't use "print" for displaying a message.
Richard M. Stallman <rms@gnu.org>
parents: 38745
diff changeset
272 (@code{calendar-count-days-region}). The numbers of days shown is
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
273 @emph{inclusive}; that is, it includes the days specified by mark and
Dave Love <fx@gnu.org>
parents:
diff changeset
274 point.
Dave Love <fx@gnu.org>
parents:
diff changeset
275
Dave Love <fx@gnu.org>
parents:
diff changeset
276 @node General Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
277 @section Miscellaneous Calendar Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
278
Dave Love <fx@gnu.org>
parents:
diff changeset
279 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
280 @item p d
Dave Love <fx@gnu.org>
parents:
diff changeset
281 Display day-in-year (@code{calendar-print-day-of-year}).
Dave Love <fx@gnu.org>
parents:
diff changeset
282 @item C-c C-l
Dave Love <fx@gnu.org>
parents:
diff changeset
283 Regenerate the calendar window (@code{redraw-calendar}).
Dave Love <fx@gnu.org>
parents:
diff changeset
284 @item SPC
Dave Love <fx@gnu.org>
parents:
diff changeset
285 Scroll the next window (@code{scroll-other-window}).
Dave Love <fx@gnu.org>
parents:
diff changeset
286 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
287 Exit from calendar (@code{exit-calendar}).
Dave Love <fx@gnu.org>
parents:
diff changeset
288 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
289
Dave Love <fx@gnu.org>
parents:
diff changeset
290 @kindex p d @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
291 @cindex day of year
Dave Love <fx@gnu.org>
parents:
diff changeset
292 @findex calendar-print-day-of-year
38870
d44abb4e68b2 Don't use "print" for displaying a message.
Richard M. Stallman <rms@gnu.org>
parents: 38745
diff changeset
293 To display the number of days elapsed since the start of the year, or
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
294 the number of days remaining in the year, type the @kbd{p d} command
Dave Love <fx@gnu.org>
parents:
diff changeset
295 (@code{calendar-print-day-of-year}). This displays both of those
Dave Love <fx@gnu.org>
parents:
diff changeset
296 numbers in the echo area. The number of days elapsed includes the
Dave Love <fx@gnu.org>
parents:
diff changeset
297 selected date. The number of days remaining does not include that
Dave Love <fx@gnu.org>
parents:
diff changeset
298 date.
Dave Love <fx@gnu.org>
parents:
diff changeset
299
Dave Love <fx@gnu.org>
parents:
diff changeset
300 @kindex C-c C-l @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
301 @findex redraw-calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
302 If the calendar window text gets corrupted, type @kbd{C-c C-l}
Dave Love <fx@gnu.org>
parents:
diff changeset
303 (@code{redraw-calendar}) to redraw it. (This can only happen if you use
Dave Love <fx@gnu.org>
parents:
diff changeset
304 non-Calendar-mode editing commands.)
Dave Love <fx@gnu.org>
parents:
diff changeset
305
Dave Love <fx@gnu.org>
parents:
diff changeset
306 @kindex SPC @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
307 In Calendar mode, you can use @kbd{SPC} (@code{scroll-other-window})
Dave Love <fx@gnu.org>
parents:
diff changeset
308 to scroll the other window. This is handy when you display a list of
Dave Love <fx@gnu.org>
parents:
diff changeset
309 holidays or diary entries in another window.
Dave Love <fx@gnu.org>
parents:
diff changeset
310
Dave Love <fx@gnu.org>
parents:
diff changeset
311 @kindex q @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
312 @findex exit-calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
313 To exit from the calendar, type @kbd{q} (@code{exit-calendar}). This
Dave Love <fx@gnu.org>
parents:
diff changeset
314 buries all buffers related to the calendar, selecting other buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
315 (If a frame contains a dedicated calendar window, exiting from the
Dave Love <fx@gnu.org>
parents:
diff changeset
316 calendar iconifies that frame.)
Dave Love <fx@gnu.org>
parents:
diff changeset
317
Dave Love <fx@gnu.org>
parents:
diff changeset
318 @node LaTeX Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
319 @section LaTeX Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
320 @cindex calendar and La@TeX{}
Dave Love <fx@gnu.org>
parents:
diff changeset
321
Dave Love <fx@gnu.org>
parents:
diff changeset
322 The Calendar La@TeX{} commands produce a buffer of La@TeX{} code that
Dave Love <fx@gnu.org>
parents:
diff changeset
323 prints as a calendar. Depending on the command you use, the printed
Dave Love <fx@gnu.org>
parents:
diff changeset
324 calendar covers the day, week, month or year that point is in.
Dave Love <fx@gnu.org>
parents:
diff changeset
325
Dave Love <fx@gnu.org>
parents:
diff changeset
326 @kindex t @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
327 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
328 @item t m
Dave Love <fx@gnu.org>
parents:
diff changeset
329 Generate a one-month calendar (@code{cal-tex-cursor-month}).
Dave Love <fx@gnu.org>
parents:
diff changeset
330 @item t M
Dave Love <fx@gnu.org>
parents:
diff changeset
331 Generate a sideways-printing one-month calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
332 (@code{cal-tex-cursor-month-landscape}).
Dave Love <fx@gnu.org>
parents:
diff changeset
333 @item t d
Dave Love <fx@gnu.org>
parents:
diff changeset
334 Generate a one-day calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
335 (@code{cal-tex-cursor-day}).
Dave Love <fx@gnu.org>
parents:
diff changeset
336 @item t w 1
Dave Love <fx@gnu.org>
parents:
diff changeset
337 Generate a one-page calendar for one week
Dave Love <fx@gnu.org>
parents:
diff changeset
338 (@code{cal-tex-cursor-week}).
Dave Love <fx@gnu.org>
parents:
diff changeset
339 @item t w 2
Dave Love <fx@gnu.org>
parents:
diff changeset
340 Generate a two-page calendar for one week
Dave Love <fx@gnu.org>
parents:
diff changeset
341 (@code{cal-tex-cursor-week2}).
Dave Love <fx@gnu.org>
parents:
diff changeset
342 @item t w 3
Dave Love <fx@gnu.org>
parents:
diff changeset
343 Generate an ISO-style calendar for one week
Dave Love <fx@gnu.org>
parents:
diff changeset
344 (@code{cal-tex-cursor-week-iso}).
Dave Love <fx@gnu.org>
parents:
diff changeset
345 @item t w 4
Dave Love <fx@gnu.org>
parents:
diff changeset
346 Generate a calendar for one Monday-starting week
Dave Love <fx@gnu.org>
parents:
diff changeset
347 (@code{cal-tex-cursor-week-monday}).
Dave Love <fx@gnu.org>
parents:
diff changeset
348 @item t f w
Dave Love <fx@gnu.org>
parents:
diff changeset
349 Generate a Filofax-style two-weeks-at-a-glance calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
350 (@code{cal-tex-cursor-filofax-2week}).
Dave Love <fx@gnu.org>
parents:
diff changeset
351 @item t f W
Dave Love <fx@gnu.org>
parents:
diff changeset
352 Generate a Filofax-style one-week-at-a-glance calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
353 (@code{cal-tex-cursor-filofax-week}).
Dave Love <fx@gnu.org>
parents:
diff changeset
354 @item t y
Dave Love <fx@gnu.org>
parents:
diff changeset
355 Generate a calendar for one year
Dave Love <fx@gnu.org>
parents:
diff changeset
356 (@code{cal-tex-cursor-year}).
Dave Love <fx@gnu.org>
parents:
diff changeset
357 @item t Y
Dave Love <fx@gnu.org>
parents:
diff changeset
358 Generate a sideways-printing calendar for one year
Dave Love <fx@gnu.org>
parents:
diff changeset
359 (@code{cal-tex-cursor-year-landscape}).
Dave Love <fx@gnu.org>
parents:
diff changeset
360 @item t f y
Dave Love <fx@gnu.org>
parents:
diff changeset
361 Generate a Filofax-style calendar for one year
Dave Love <fx@gnu.org>
parents:
diff changeset
362 (@code{cal-tex-cursor-filofax-year}).
Dave Love <fx@gnu.org>
parents:
diff changeset
363 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
364
Dave Love <fx@gnu.org>
parents:
diff changeset
365 Some of these commands print the calendar sideways (in ``landscape
Dave Love <fx@gnu.org>
parents:
diff changeset
366 mode''), so it can be wider than it is long. Some of them use Filofax
Dave Love <fx@gnu.org>
parents:
diff changeset
367 paper size (3.75in x 6.75in). All of these commands accept a prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
368 argument which specifies how many days, weeks, months or years to print
Dave Love <fx@gnu.org>
parents:
diff changeset
369 (starting always with the selected one).
Dave Love <fx@gnu.org>
parents:
diff changeset
370
Dave Love <fx@gnu.org>
parents:
diff changeset
371 If the variable @code{cal-tex-holidays} is non-@code{nil} (the default),
Dave Love <fx@gnu.org>
parents:
diff changeset
372 then the printed calendars show the holidays in @code{calendar-holidays}.
Dave Love <fx@gnu.org>
parents:
diff changeset
373 If the variable @code{cal-tex-diary} is non-@code{nil} (the default is
Dave Love <fx@gnu.org>
parents:
diff changeset
374 @code{nil}), diary entries are included also (in weekly and monthly
Dave Love <fx@gnu.org>
parents:
diff changeset
375 calendars only). If the variable @code{cal-tex-rules} is non-@code{nil}
36145
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
376 (the default is @code{nil}), the calendar displays ruled pages
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
377 in styles that have sufficient room.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
378
Dave Love <fx@gnu.org>
parents:
diff changeset
379 @node Holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
380 @section Holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
381 @cindex holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
382
Dave Love <fx@gnu.org>
parents:
diff changeset
383 The Emacs calendar knows about all major and many minor holidays,
Dave Love <fx@gnu.org>
parents:
diff changeset
384 and can display them.
Dave Love <fx@gnu.org>
parents:
diff changeset
385
Dave Love <fx@gnu.org>
parents:
diff changeset
386 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
387 @item h
Dave Love <fx@gnu.org>
parents:
diff changeset
388 Display holidays for the selected date
Dave Love <fx@gnu.org>
parents:
diff changeset
389 (@code{calendar-cursor-holidays}).
Dave Love <fx@gnu.org>
parents:
diff changeset
390 @item Mouse-2 Holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
391 Display any holidays for the date you click on.
Dave Love <fx@gnu.org>
parents:
diff changeset
392 @item x
Dave Love <fx@gnu.org>
parents:
diff changeset
393 Mark holidays in the calendar window (@code{mark-calendar-holidays}).
Dave Love <fx@gnu.org>
parents:
diff changeset
394 @item u
Dave Love <fx@gnu.org>
parents:
diff changeset
395 Unmark calendar window (@code{calendar-unmark}).
Dave Love <fx@gnu.org>
parents:
diff changeset
396 @item a
Dave Love <fx@gnu.org>
parents:
diff changeset
397 List all holidays for the displayed three months in another window
Dave Love <fx@gnu.org>
parents:
diff changeset
398 (@code{list-calendar-holidays}).
Dave Love <fx@gnu.org>
parents:
diff changeset
399 @item M-x holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
400 List all holidays for three months around today's date in another
Dave Love <fx@gnu.org>
parents:
diff changeset
401 window.
Dave Love <fx@gnu.org>
parents:
diff changeset
402 @item M-x list-holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
403 List holidays in another window for a specified range of years.
Dave Love <fx@gnu.org>
parents:
diff changeset
404 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
405
Dave Love <fx@gnu.org>
parents:
diff changeset
406 @kindex h @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
407 @findex calendar-cursor-holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
408 To see if any holidays fall on a given date, position point on that
Dave Love <fx@gnu.org>
parents:
diff changeset
409 date in the calendar window and use the @kbd{h} command. Alternatively,
Dave Love <fx@gnu.org>
parents:
diff changeset
410 click on that date with @kbd{Mouse-2} and then choose @kbd{Holidays}
Dave Love <fx@gnu.org>
parents:
diff changeset
411 from the menu that appears. Either way, this displays the holidays for
Dave Love <fx@gnu.org>
parents:
diff changeset
412 that date, in the echo area if they fit there, otherwise in a separate
Dave Love <fx@gnu.org>
parents:
diff changeset
413 window.
Dave Love <fx@gnu.org>
parents:
diff changeset
414
Dave Love <fx@gnu.org>
parents:
diff changeset
415 @kindex x @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
416 @findex mark-calendar-holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
417 @kindex u @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
418 @findex calendar-unmark
Dave Love <fx@gnu.org>
parents:
diff changeset
419 To view the distribution of holidays for all the dates shown in the
Dave Love <fx@gnu.org>
parents:
diff changeset
420 calendar, use the @kbd{x} command. This displays the dates that are
Dave Love <fx@gnu.org>
parents:
diff changeset
421 holidays in a different face (or places a @samp{*} after these dates, if
Dave Love <fx@gnu.org>
parents:
diff changeset
422 display with multiple faces is not available). The command applies both
Dave Love <fx@gnu.org>
parents:
diff changeset
423 to the currently visible months and to other months that subsequently
Dave Love <fx@gnu.org>
parents:
diff changeset
424 become visible by scrolling. To turn marking off and erase the current
Dave Love <fx@gnu.org>
parents:
diff changeset
425 marks, type @kbd{u}, which also erases any diary marks (@pxref{Diary}).
Dave Love <fx@gnu.org>
parents:
diff changeset
426
Dave Love <fx@gnu.org>
parents:
diff changeset
427 @kindex a @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
428 @findex list-calendar-holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
429 To get even more detailed information, use the @kbd{a} command, which
Dave Love <fx@gnu.org>
parents:
diff changeset
430 displays a separate buffer containing a list of all holidays in the
Dave Love <fx@gnu.org>
parents:
diff changeset
431 current three-month range. You can use @key{SPC} in the calendar window
Dave Love <fx@gnu.org>
parents:
diff changeset
432 to scroll that list.
Dave Love <fx@gnu.org>
parents:
diff changeset
433
Dave Love <fx@gnu.org>
parents:
diff changeset
434 @findex holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
435 The command @kbd{M-x holidays} displays the list of holidays for the
Dave Love <fx@gnu.org>
parents:
diff changeset
436 current month and the preceding and succeeding months; this works even
Dave Love <fx@gnu.org>
parents:
diff changeset
437 if you don't have a calendar window. If you want the list of holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
438 centered around a different month, use @kbd{C-u M-x holidays}, which
Dave Love <fx@gnu.org>
parents:
diff changeset
439 prompts for the month and year.
Dave Love <fx@gnu.org>
parents:
diff changeset
440
Dave Love <fx@gnu.org>
parents:
diff changeset
441 The holidays known to Emacs include United States holidays and the
37142
e107572ba2dd Undo last commit by John Wiegley.
Gerd Moellmann <gerd@gnu.org>
parents: 36909
diff changeset
442 major Christian, Jewish, and Islamic holidays; also the solstices and
e107572ba2dd Undo last commit by John Wiegley.
Gerd Moellmann <gerd@gnu.org>
parents: 36909
diff changeset
443 equinoxes.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
444
Dave Love <fx@gnu.org>
parents:
diff changeset
445 @findex list-holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
446 The command @kbd{M-x list-holidays} displays the list of holidays for
Dave Love <fx@gnu.org>
parents:
diff changeset
447 a range of years. This function asks you for the starting and stopping
Dave Love <fx@gnu.org>
parents:
diff changeset
448 years, and allows you to choose all the holidays or one of several
Dave Love <fx@gnu.org>
parents:
diff changeset
449 categories of holidays. You can use this command even if you don't have
Dave Love <fx@gnu.org>
parents:
diff changeset
450 a calendar window.
Dave Love <fx@gnu.org>
parents:
diff changeset
451
Dave Love <fx@gnu.org>
parents:
diff changeset
452 The dates used by Emacs for holidays are based on @emph{current
Dave Love <fx@gnu.org>
parents:
diff changeset
453 practice}, not historical fact. Historically, for instance, the start
Dave Love <fx@gnu.org>
parents:
diff changeset
454 of daylight savings time and even its existence have varied from year to
Dave Love <fx@gnu.org>
parents:
diff changeset
455 year, but present United States law mandates that daylight savings time
Dave Love <fx@gnu.org>
parents:
diff changeset
456 begins on the first Sunday in April. When the daylight savings rules
Dave Love <fx@gnu.org>
parents:
diff changeset
457 are set up for the United States, Emacs always uses the present
Dave Love <fx@gnu.org>
parents:
diff changeset
458 definition, even though it is wrong for some prior years.
Dave Love <fx@gnu.org>
parents:
diff changeset
459
Dave Love <fx@gnu.org>
parents:
diff changeset
460 @node Sunrise/Sunset
Dave Love <fx@gnu.org>
parents:
diff changeset
461 @section Times of Sunrise and Sunset
Dave Love <fx@gnu.org>
parents:
diff changeset
462 @cindex sunrise and sunset
Dave Love <fx@gnu.org>
parents:
diff changeset
463
Dave Love <fx@gnu.org>
parents:
diff changeset
464 Special calendar commands can tell you, to within a minute or two, the
Dave Love <fx@gnu.org>
parents:
diff changeset
465 times of sunrise and sunset for any date.
Dave Love <fx@gnu.org>
parents:
diff changeset
466
Dave Love <fx@gnu.org>
parents:
diff changeset
467 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
468 @item S
Dave Love <fx@gnu.org>
parents:
diff changeset
469 Display times of sunrise and sunset for the selected date
Dave Love <fx@gnu.org>
parents:
diff changeset
470 (@code{calendar-sunrise-sunset}).
37709
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
471 @item Mouse-2 Sunrise/sunset
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
472 Display times of sunrise and sunset for the date you click on.
Dave Love <fx@gnu.org>
parents:
diff changeset
473 @item M-x sunrise-sunset
Dave Love <fx@gnu.org>
parents:
diff changeset
474 Display times of sunrise and sunset for today's date.
Dave Love <fx@gnu.org>
parents:
diff changeset
475 @item C-u M-x sunrise-sunset
Dave Love <fx@gnu.org>
parents:
diff changeset
476 Display times of sunrise and sunset for a specified date.
Dave Love <fx@gnu.org>
parents:
diff changeset
477 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
478
Dave Love <fx@gnu.org>
parents:
diff changeset
479 @kindex S @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
480 @findex calendar-sunrise-sunset
Dave Love <fx@gnu.org>
parents:
diff changeset
481 @findex sunrise-sunset
Dave Love <fx@gnu.org>
parents:
diff changeset
482 Within the calendar, to display the @emph{local times} of sunrise and
Dave Love <fx@gnu.org>
parents:
diff changeset
483 sunset in the echo area, move point to the date you want, and type
Dave Love <fx@gnu.org>
parents:
diff changeset
484 @kbd{S}. Alternatively, click @kbd{Mouse-2} on the date, then choose
37709
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
485 @samp{Sunrise/sunset} from the menu that appears. The command @kbd{M-x
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
486 sunrise-sunset} is available outside the calendar to display this
Dave Love <fx@gnu.org>
parents:
diff changeset
487 information for today's date or a specified date. To specify a date
Dave Love <fx@gnu.org>
parents:
diff changeset
488 other than today, use @kbd{C-u M-x sunrise-sunset}, which prompts for
Dave Love <fx@gnu.org>
parents:
diff changeset
489 the year, month, and day.
Dave Love <fx@gnu.org>
parents:
diff changeset
490
Dave Love <fx@gnu.org>
parents:
diff changeset
491 You can display the times of sunrise and sunset for any location and
Dave Love <fx@gnu.org>
parents:
diff changeset
492 any date with @kbd{C-u C-u M-x sunrise-sunset}. This asks you for a
Dave Love <fx@gnu.org>
parents:
diff changeset
493 longitude, latitude, number of minutes difference from Coordinated
Dave Love <fx@gnu.org>
parents:
diff changeset
494 Universal Time, and date, and then tells you the times of sunrise and
Dave Love <fx@gnu.org>
parents:
diff changeset
495 sunset for that location on that date.
Dave Love <fx@gnu.org>
parents:
diff changeset
496
Dave Love <fx@gnu.org>
parents:
diff changeset
497 Because the times of sunrise and sunset depend on the location on
Dave Love <fx@gnu.org>
parents:
diff changeset
498 earth, you need to tell Emacs your latitude, longitude, and location
Dave Love <fx@gnu.org>
parents:
diff changeset
499 name before using these commands. Here is an example of what to set:
Dave Love <fx@gnu.org>
parents:
diff changeset
500
Dave Love <fx@gnu.org>
parents:
diff changeset
501 @vindex calendar-location-name
Dave Love <fx@gnu.org>
parents:
diff changeset
502 @vindex calendar-longitude
Dave Love <fx@gnu.org>
parents:
diff changeset
503 @vindex calendar-latitude
Dave Love <fx@gnu.org>
parents:
diff changeset
504 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
505 (setq calendar-latitude 40.1)
Dave Love <fx@gnu.org>
parents:
diff changeset
506 (setq calendar-longitude -88.2)
Dave Love <fx@gnu.org>
parents:
diff changeset
507 (setq calendar-location-name "Urbana, IL")
Dave Love <fx@gnu.org>
parents:
diff changeset
508 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
509
Dave Love <fx@gnu.org>
parents:
diff changeset
510 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
511 Use one decimal place in the values of @code{calendar-latitude} and
Dave Love <fx@gnu.org>
parents:
diff changeset
512 @code{calendar-longitude}.
Dave Love <fx@gnu.org>
parents:
diff changeset
513
Dave Love <fx@gnu.org>
parents:
diff changeset
514 Your time zone also affects the local time of sunrise and sunset.
Dave Love <fx@gnu.org>
parents:
diff changeset
515 Emacs usually gets time zone information from the operating system, but
Dave Love <fx@gnu.org>
parents:
diff changeset
516 if these values are not what you want (or if the operating system does
Dave Love <fx@gnu.org>
parents:
diff changeset
517 not supply them), you must set them yourself. Here is an example:
Dave Love <fx@gnu.org>
parents:
diff changeset
518
Dave Love <fx@gnu.org>
parents:
diff changeset
519 @vindex calendar-time-zone
Dave Love <fx@gnu.org>
parents:
diff changeset
520 @vindex calendar-standard-time-zone-name
Dave Love <fx@gnu.org>
parents:
diff changeset
521 @vindex calendar-daylight-time-zone-name
Dave Love <fx@gnu.org>
parents:
diff changeset
522 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
523 (setq calendar-time-zone -360)
Dave Love <fx@gnu.org>
parents:
diff changeset
524 (setq calendar-standard-time-zone-name "CST")
Dave Love <fx@gnu.org>
parents:
diff changeset
525 (setq calendar-daylight-time-zone-name "CDT")
Dave Love <fx@gnu.org>
parents:
diff changeset
526 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
527
Dave Love <fx@gnu.org>
parents:
diff changeset
528 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
529 The value of @code{calendar-time-zone} is the number of minutes
Dave Love <fx@gnu.org>
parents:
diff changeset
530 difference between your local standard time and Coordinated Universal
Dave Love <fx@gnu.org>
parents:
diff changeset
531 Time (Greenwich time). The values of
Dave Love <fx@gnu.org>
parents:
diff changeset
532 @code{calendar-standard-time-zone-name} and
Dave Love <fx@gnu.org>
parents:
diff changeset
533 @code{calendar-daylight-time-zone-name} are the abbreviations used in
Dave Love <fx@gnu.org>
parents:
diff changeset
534 your time zone. Emacs displays the times of sunrise and sunset
Dave Love <fx@gnu.org>
parents:
diff changeset
535 @emph{corrected for daylight savings time}. @xref{Daylight Savings},
Dave Love <fx@gnu.org>
parents:
diff changeset
536 for how daylight savings time is determined.
Dave Love <fx@gnu.org>
parents:
diff changeset
537
Dave Love <fx@gnu.org>
parents:
diff changeset
538 As a user, you might find it convenient to set the calendar location
Dave Love <fx@gnu.org>
parents:
diff changeset
539 variables for your usual physical location in your @file{.emacs} file.
Dave Love <fx@gnu.org>
parents:
diff changeset
540 And when you install Emacs on a machine, you can create a
Dave Love <fx@gnu.org>
parents:
diff changeset
541 @file{default.el} file which sets them properly for the typical location
Dave Love <fx@gnu.org>
parents:
diff changeset
542 of most users of that machine. @xref{Init File}.
Dave Love <fx@gnu.org>
parents:
diff changeset
543
Dave Love <fx@gnu.org>
parents:
diff changeset
544 @node Lunar Phases
Dave Love <fx@gnu.org>
parents:
diff changeset
545 @section Phases of the Moon
Dave Love <fx@gnu.org>
parents:
diff changeset
546 @cindex phases of the moon
Dave Love <fx@gnu.org>
parents:
diff changeset
547 @cindex moon, phases of
Dave Love <fx@gnu.org>
parents:
diff changeset
548
Dave Love <fx@gnu.org>
parents:
diff changeset
549 These calendar commands display the dates and times of the phases of
Dave Love <fx@gnu.org>
parents:
diff changeset
550 the moon (new moon, first quarter, full moon, last quarter). This
Dave Love <fx@gnu.org>
parents:
diff changeset
551 feature is useful for debugging problems that ``depend on the phase of
Dave Love <fx@gnu.org>
parents:
diff changeset
552 the moon.''
Dave Love <fx@gnu.org>
parents:
diff changeset
553
Dave Love <fx@gnu.org>
parents:
diff changeset
554 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
555 @item M
Dave Love <fx@gnu.org>
parents:
diff changeset
556 Display the dates and times for all the quarters of the moon for the
Dave Love <fx@gnu.org>
parents:
diff changeset
557 three-month period shown (@code{calendar-phases-of-moon}).
Dave Love <fx@gnu.org>
parents:
diff changeset
558 @item M-x phases-of-moon
Dave Love <fx@gnu.org>
parents:
diff changeset
559 Display dates and times of the quarters of the moon for three months around
Dave Love <fx@gnu.org>
parents:
diff changeset
560 today's date.
Dave Love <fx@gnu.org>
parents:
diff changeset
561 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
562
Dave Love <fx@gnu.org>
parents:
diff changeset
563 @kindex M @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
564 @findex calendar-phases-of-moon
Dave Love <fx@gnu.org>
parents:
diff changeset
565 Within the calendar, use the @kbd{M} command to display a separate
Dave Love <fx@gnu.org>
parents:
diff changeset
566 buffer of the phases of the moon for the current three-month range. The
Dave Love <fx@gnu.org>
parents:
diff changeset
567 dates and times listed are accurate to within a few minutes.
Dave Love <fx@gnu.org>
parents:
diff changeset
568
Dave Love <fx@gnu.org>
parents:
diff changeset
569 @findex phases-of-moon
Dave Love <fx@gnu.org>
parents:
diff changeset
570 Outside the calendar, use the command @kbd{M-x phases-of-moon} to
Dave Love <fx@gnu.org>
parents:
diff changeset
571 display the list of the phases of the moon for the current month and the
Dave Love <fx@gnu.org>
parents:
diff changeset
572 preceding and succeeding months. For information about a different
Dave Love <fx@gnu.org>
parents:
diff changeset
573 month, use @kbd{C-u M-x phases-of-moon}, which prompts for the month and
Dave Love <fx@gnu.org>
parents:
diff changeset
574 year.
Dave Love <fx@gnu.org>
parents:
diff changeset
575
Dave Love <fx@gnu.org>
parents:
diff changeset
576 The dates and times given for the phases of the moon are given in
Dave Love <fx@gnu.org>
parents:
diff changeset
577 local time (corrected for daylight savings, when appropriate); but if
Dave Love <fx@gnu.org>
parents:
diff changeset
578 the variable @code{calendar-time-zone} is void, Coordinated Universal
Dave Love <fx@gnu.org>
parents:
diff changeset
579 Time (the Greenwich time zone) is used. @xref{Daylight Savings}.
Dave Love <fx@gnu.org>
parents:
diff changeset
580
Dave Love <fx@gnu.org>
parents:
diff changeset
581 @node Other Calendars
Dave Love <fx@gnu.org>
parents:
diff changeset
582 @section Conversion To and From Other Calendars
Dave Love <fx@gnu.org>
parents:
diff changeset
583
Dave Love <fx@gnu.org>
parents:
diff changeset
584 @cindex Gregorian calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
585 The Emacs calendar displayed is @emph{always} the Gregorian calendar,
Dave Love <fx@gnu.org>
parents:
diff changeset
586 sometimes called the ``new style'' calendar, which is used in most of
Dave Love <fx@gnu.org>
parents:
diff changeset
587 the world today. However, this calendar did not exist before the
Dave Love <fx@gnu.org>
parents:
diff changeset
588 sixteenth century and was not widely used before the eighteenth century;
Dave Love <fx@gnu.org>
parents:
diff changeset
589 it did not fully displace the Julian calendar and gain universal
Dave Love <fx@gnu.org>
parents:
diff changeset
590 acceptance until the early twentieth century. The Emacs calendar can
Dave Love <fx@gnu.org>
parents:
diff changeset
591 display any month since January, year 1 of the current era, but the
Dave Love <fx@gnu.org>
parents:
diff changeset
592 calendar displayed is the Gregorian, even for a date at which the
Dave Love <fx@gnu.org>
parents:
diff changeset
593 Gregorian calendar did not exist.
Dave Love <fx@gnu.org>
parents:
diff changeset
594
Dave Love <fx@gnu.org>
parents:
diff changeset
595 While Emacs cannot display other calendars, it can convert dates to
Dave Love <fx@gnu.org>
parents:
diff changeset
596 and from several other calendars.
Dave Love <fx@gnu.org>
parents:
diff changeset
597
Dave Love <fx@gnu.org>
parents:
diff changeset
598 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
599 * Calendar Systems:: The calendars Emacs understands
Dave Love <fx@gnu.org>
parents:
diff changeset
600 (aside from Gregorian).
Dave Love <fx@gnu.org>
parents:
diff changeset
601 * To Other Calendar:: Converting the selected date to various calendars.
Dave Love <fx@gnu.org>
parents:
diff changeset
602 * From Other Calendar:: Moving to a date specified in another calendar.
Dave Love <fx@gnu.org>
parents:
diff changeset
603 * Mayan Calendar:: Moving to a date specified in a Mayan calendar.
Dave Love <fx@gnu.org>
parents:
diff changeset
604 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
605
Dave Love <fx@gnu.org>
parents:
diff changeset
606 @node Calendar Systems
Dave Love <fx@gnu.org>
parents:
diff changeset
607 @subsection Supported Calendar Systems
Dave Love <fx@gnu.org>
parents:
diff changeset
608
Dave Love <fx@gnu.org>
parents:
diff changeset
609 @cindex ISO commercial calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
610 The ISO commercial calendar is used largely in Europe.
Dave Love <fx@gnu.org>
parents:
diff changeset
611
Dave Love <fx@gnu.org>
parents:
diff changeset
612 @cindex Julian calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
613 The Julian calendar, named after Julius Caesar, was the one used in Europe
Dave Love <fx@gnu.org>
parents:
diff changeset
614 throughout medieval times, and in many countries up until the nineteenth
Dave Love <fx@gnu.org>
parents:
diff changeset
615 century.
Dave Love <fx@gnu.org>
parents:
diff changeset
616
Dave Love <fx@gnu.org>
parents:
diff changeset
617 @cindex Julian day numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
618 @cindex astronomical day numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
619 Astronomers use a simple counting of days elapsed since noon, Monday,
Dave Love <fx@gnu.org>
parents:
diff changeset
620 January 1, 4713 B.C. on the Julian calendar. The number of days elapsed
36263
11db0318031d Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents: 36145
diff changeset
621 is called the @dfn{Julian day number} or the @dfn{Astronomical day number}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
622
Dave Love <fx@gnu.org>
parents:
diff changeset
623 @cindex Hebrew calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
624 The Hebrew calendar is used by tradition in the Jewish religion. The
Dave Love <fx@gnu.org>
parents:
diff changeset
625 Emacs calendar program uses the Hebrew calendar to determine the dates
Dave Love <fx@gnu.org>
parents:
diff changeset
626 of Jewish holidays. Hebrew calendar dates begin and end at sunset.
Dave Love <fx@gnu.org>
parents:
diff changeset
627
Dave Love <fx@gnu.org>
parents:
diff changeset
628 @cindex Islamic calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
629 The Islamic calendar is used in many predominantly Islamic countries.
Dave Love <fx@gnu.org>
parents:
diff changeset
630 Emacs uses it to determine the dates of Islamic holidays. There is no
Dave Love <fx@gnu.org>
parents:
diff changeset
631 universal agreement in the Islamic world about the calendar; Emacs uses
Dave Love <fx@gnu.org>
parents:
diff changeset
632 a widely accepted version, but the precise dates of Islamic holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
633 often depend on proclamation by religious authorities, not on
Dave Love <fx@gnu.org>
parents:
diff changeset
634 calculations. As a consequence, the actual dates of observance can vary
Dave Love <fx@gnu.org>
parents:
diff changeset
635 slightly from the dates computed by Emacs. Islamic calendar dates begin
Dave Love <fx@gnu.org>
parents:
diff changeset
636 and end at sunset.
Dave Love <fx@gnu.org>
parents:
diff changeset
637
Dave Love <fx@gnu.org>
parents:
diff changeset
638 @cindex French Revolutionary calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
639 The French Revolutionary calendar was created by the Jacobins after the 1789
Dave Love <fx@gnu.org>
parents:
diff changeset
640 revolution, to represent a more secular and nature-based view of the annual
Dave Love <fx@gnu.org>
parents:
diff changeset
641 cycle, and to install a 10-day week in a rationalization measure similar to
Dave Love <fx@gnu.org>
parents:
diff changeset
642 the metric system. The French government officially abandoned this
Dave Love <fx@gnu.org>
parents:
diff changeset
643 calendar at the end of 1805.
Dave Love <fx@gnu.org>
parents:
diff changeset
644
Dave Love <fx@gnu.org>
parents:
diff changeset
645 @cindex Mayan calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
646 The Maya of Central America used three separate, overlapping calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
647 systems, the @emph{long count}, the @emph{tzolkin}, and the @emph{haab}.
Dave Love <fx@gnu.org>
parents:
diff changeset
648 Emacs knows about all three of these calendars. Experts dispute the
Dave Love <fx@gnu.org>
parents:
diff changeset
649 exact correlation between the Mayan calendar and our calendar; Emacs uses the
Dave Love <fx@gnu.org>
parents:
diff changeset
650 Goodman-Martinez-Thompson correlation in its calculations.
Dave Love <fx@gnu.org>
parents:
diff changeset
651
Dave Love <fx@gnu.org>
parents:
diff changeset
652 @cindex Coptic calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
653 @cindex Ethiopic calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
654 The Copts use a calendar based on the ancient Egyptian solar calendar.
Dave Love <fx@gnu.org>
parents:
diff changeset
655 Their calendar consists of twelve 30-day months followed by an extra
Dave Love <fx@gnu.org>
parents:
diff changeset
656 five-day period. Once every fourth year they add a leap day to this
Dave Love <fx@gnu.org>
parents:
diff changeset
657 extra period to make it six days. The Ethiopic calendar is identical in
Dave Love <fx@gnu.org>
parents:
diff changeset
658 structure, but has different year numbers and month names.
Dave Love <fx@gnu.org>
parents:
diff changeset
659
Dave Love <fx@gnu.org>
parents:
diff changeset
660 @cindex Persian calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
661 The Persians use a solar calendar based on a design of Omar Khayyam.
Dave Love <fx@gnu.org>
parents:
diff changeset
662 Their calendar consists of twelve months of which the first six have 31
Dave Love <fx@gnu.org>
parents:
diff changeset
663 days, the next five have 30 days, and the last has 29 in ordinary years
Dave Love <fx@gnu.org>
parents:
diff changeset
664 and 30 in leap years. Leap years occur in a complicated pattern every
Dave Love <fx@gnu.org>
parents:
diff changeset
665 four or five years.
Dave Love <fx@gnu.org>
parents:
diff changeset
666
Dave Love <fx@gnu.org>
parents:
diff changeset
667 @cindex Chinese calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
668 The Chinese calendar is a complicated system of lunar months arranged
Dave Love <fx@gnu.org>
parents:
diff changeset
669 into solar years. The years go in cycles of sixty, each year containing
Dave Love <fx@gnu.org>
parents:
diff changeset
670 either twelve months in an ordinary year or thirteen months in a leap
Dave Love <fx@gnu.org>
parents:
diff changeset
671 year; each month has either 29 or 30 days. Years, ordinary months, and
Dave Love <fx@gnu.org>
parents:
diff changeset
672 days are named by combining one of ten ``celestial stems'' with one of
Dave Love <fx@gnu.org>
parents:
diff changeset
673 twelve ``terrestrial branches'' for a total of sixty names that are
Dave Love <fx@gnu.org>
parents:
diff changeset
674 repeated in a cycle of sixty.
Dave Love <fx@gnu.org>
parents:
diff changeset
675
Dave Love <fx@gnu.org>
parents:
diff changeset
676 @node To Other Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
677 @subsection Converting To Other Calendars
Dave Love <fx@gnu.org>
parents:
diff changeset
678
Dave Love <fx@gnu.org>
parents:
diff changeset
679 The following commands describe the selected date (the date at point)
Dave Love <fx@gnu.org>
parents:
diff changeset
680 in various other calendar systems:
Dave Love <fx@gnu.org>
parents:
diff changeset
681
Dave Love <fx@gnu.org>
parents:
diff changeset
682 @table @kbd
37709
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
683 @item Mouse-2 Other calendars
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
684 Display the date that you click on, expressed in various other calendars.
Dave Love <fx@gnu.org>
parents:
diff changeset
685 @kindex p @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
686 @findex calendar-print-iso-date
Dave Love <fx@gnu.org>
parents:
diff changeset
687 @item p c
Dave Love <fx@gnu.org>
parents:
diff changeset
688 Display ISO commercial calendar equivalent for selected day
Dave Love <fx@gnu.org>
parents:
diff changeset
689 (@code{calendar-print-iso-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
690 @findex calendar-print-julian-date
Dave Love <fx@gnu.org>
parents:
diff changeset
691 @item p j
Dave Love <fx@gnu.org>
parents:
diff changeset
692 Display Julian date for selected day (@code{calendar-print-julian-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
693 @findex calendar-print-astro-day-number
Dave Love <fx@gnu.org>
parents:
diff changeset
694 @item p a
Dave Love <fx@gnu.org>
parents:
diff changeset
695 Display astronomical (Julian) day number for selected day
Dave Love <fx@gnu.org>
parents:
diff changeset
696 (@code{calendar-print-astro-day-number}).
Dave Love <fx@gnu.org>
parents:
diff changeset
697 @findex calendar-print-hebrew-date
Dave Love <fx@gnu.org>
parents:
diff changeset
698 @item p h
Dave Love <fx@gnu.org>
parents:
diff changeset
699 Display Hebrew date for selected day (@code{calendar-print-hebrew-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
700 @findex calendar-print-islamic-date
Dave Love <fx@gnu.org>
parents:
diff changeset
701 @item p i
Dave Love <fx@gnu.org>
parents:
diff changeset
702 Display Islamic date for selected day (@code{calendar-print-islamic-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
703 @findex calendar-print-french-date
Dave Love <fx@gnu.org>
parents:
diff changeset
704 @item p f
Dave Love <fx@gnu.org>
parents:
diff changeset
705 Display French Revolutionary date for selected day
Dave Love <fx@gnu.org>
parents:
diff changeset
706 (@code{calendar-print-french-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
707 @findex calendar-print-chinese-date
Dave Love <fx@gnu.org>
parents:
diff changeset
708 @item p C
Dave Love <fx@gnu.org>
parents:
diff changeset
709 Display Chinese date for selected day
Dave Love <fx@gnu.org>
parents:
diff changeset
710 (@code{calendar-print-chinese-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
711 @findex calendar-print-coptic-date
Dave Love <fx@gnu.org>
parents:
diff changeset
712 @item p k
Dave Love <fx@gnu.org>
parents:
diff changeset
713 Display Coptic date for selected day
Dave Love <fx@gnu.org>
parents:
diff changeset
714 (@code{calendar-print-coptic-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
715 @findex calendar-print-ethiopic-date
Dave Love <fx@gnu.org>
parents:
diff changeset
716 @item p e
Dave Love <fx@gnu.org>
parents:
diff changeset
717 Display Ethiopic date for selected day
Dave Love <fx@gnu.org>
parents:
diff changeset
718 (@code{calendar-print-ethiopic-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
719 @findex calendar-print-persian-date
Dave Love <fx@gnu.org>
parents:
diff changeset
720 @item p p
Dave Love <fx@gnu.org>
parents:
diff changeset
721 Display Persian date for selected day
Dave Love <fx@gnu.org>
parents:
diff changeset
722 (@code{calendar-print-persian-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
723 @findex calendar-print-mayan-date
Dave Love <fx@gnu.org>
parents:
diff changeset
724 @item p m
Dave Love <fx@gnu.org>
parents:
diff changeset
725 Display Mayan date for selected day (@code{calendar-print-mayan-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
726 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
727
Dave Love <fx@gnu.org>
parents:
diff changeset
728 If you are using X, the easiest way to translate a date into other
Dave Love <fx@gnu.org>
parents:
diff changeset
729 calendars is to click on it with @kbd{Mouse-2}, then choose @kbd{Other
37709
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
730 calendars} from the menu that appears. This displays the equivalent
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
731 forms of the date in all the calendars Emacs understands, in the form of
Dave Love <fx@gnu.org>
parents:
diff changeset
732 a menu. (Choosing an alternative from this menu doesn't actually do
Dave Love <fx@gnu.org>
parents:
diff changeset
733 anything---the menu is used only for display.)
Dave Love <fx@gnu.org>
parents:
diff changeset
734
37709
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
735 Otherwise, move point to the date you want to convert, then type the
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
736 appropriate command starting with @kbd{p} from the table above. The
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
737 prefix @kbd{p} is a mnemonic for ``print,'' since Emacs ``prints'' the
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
738 equivalent date in the echo area.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
739
Dave Love <fx@gnu.org>
parents:
diff changeset
740 @node From Other Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
741 @subsection Converting From Other Calendars
Dave Love <fx@gnu.org>
parents:
diff changeset
742
Dave Love <fx@gnu.org>
parents:
diff changeset
743 You can use the other supported calendars to specify a date to move
Dave Love <fx@gnu.org>
parents:
diff changeset
744 to. This section describes the commands for doing this using calendars
Dave Love <fx@gnu.org>
parents:
diff changeset
745 other than Mayan; for the Mayan calendar, see the following section.
Dave Love <fx@gnu.org>
parents:
diff changeset
746
Dave Love <fx@gnu.org>
parents:
diff changeset
747 @kindex g @var{char} @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
748 @findex calendar-goto-iso-date
Dave Love <fx@gnu.org>
parents:
diff changeset
749 @findex calendar-goto-julian-date
Dave Love <fx@gnu.org>
parents:
diff changeset
750 @findex calendar-goto-astro-day-number
Dave Love <fx@gnu.org>
parents:
diff changeset
751 @findex calendar-goto-hebrew-date
Dave Love <fx@gnu.org>
parents:
diff changeset
752 @findex calendar-goto-islamic-date
Dave Love <fx@gnu.org>
parents:
diff changeset
753 @findex calendar-goto-french-date
Dave Love <fx@gnu.org>
parents:
diff changeset
754 @findex calendar-goto-chinese-date
Dave Love <fx@gnu.org>
parents:
diff changeset
755 @findex calendar-goto-persian-date
Dave Love <fx@gnu.org>
parents:
diff changeset
756 @findex calendar-goto-coptic-date
Dave Love <fx@gnu.org>
parents:
diff changeset
757 @findex calendar-goto-ethiopic-date
Dave Love <fx@gnu.org>
parents:
diff changeset
758 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
759 @item g c
Dave Love <fx@gnu.org>
parents:
diff changeset
760 Move to a date specified in the ISO commercial calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
761 (@code{calendar-goto-iso-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
762 @item g j
Dave Love <fx@gnu.org>
parents:
diff changeset
763 Move to a date specified in the Julian calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
764 (@code{calendar-goto-julian-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
765 @item g a
38156
e46c555b62c8 Minor change.
Richard M. Stallman <rms@gnu.org>
parents: 38125
diff changeset
766 Move to a date specified with an astronomical (Julian) day number
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
767 (@code{calendar-goto-astro-day-number}).
Dave Love <fx@gnu.org>
parents:
diff changeset
768 @item g h
Dave Love <fx@gnu.org>
parents:
diff changeset
769 Move to a date specified in the Hebrew calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
770 (@code{calendar-goto-hebrew-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
771 @item g i
Dave Love <fx@gnu.org>
parents:
diff changeset
772 Move to a date specified in the Islamic calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
773 (@code{calendar-goto-islamic-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
774 @item g f
Dave Love <fx@gnu.org>
parents:
diff changeset
775 Move to a date specified in the French Revolutionary calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
776 (@code{calendar-goto-french-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
777 @item g C
Dave Love <fx@gnu.org>
parents:
diff changeset
778 Move to a date specified in the Chinese calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
779 (@code{calendar-goto-chinese-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
780 @item g p
Dave Love <fx@gnu.org>
parents:
diff changeset
781 Move to a date specified in the Persian calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
782 (@code{calendar-goto-persian-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
783 @item g k
Dave Love <fx@gnu.org>
parents:
diff changeset
784 Move to a date specified in the Coptic calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
785 (@code{calendar-goto-coptic-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
786 @item g e
Dave Love <fx@gnu.org>
parents:
diff changeset
787 Move to a date specified in the Ethiopic calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
788 (@code{calendar-goto-ethiopic-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
789 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
790
Dave Love <fx@gnu.org>
parents:
diff changeset
791 These commands ask you for a date on the other calendar, move point to
Dave Love <fx@gnu.org>
parents:
diff changeset
792 the Gregorian calendar date equivalent to that date, and display the
Dave Love <fx@gnu.org>
parents:
diff changeset
793 other calendar's date in the echo area. Emacs uses strict completion
Dave Love <fx@gnu.org>
parents:
diff changeset
794 (@pxref{Completion}) whenever it asks you to type a month name, so you
37142
e107572ba2dd Undo last commit by John Wiegley.
Gerd Moellmann <gerd@gnu.org>
parents: 36909
diff changeset
795 don't have to worry about the spelling of Hebrew, Islamic, or French names.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
796
Dave Love <fx@gnu.org>
parents:
diff changeset
797 @findex list-yahrzeit-dates
Dave Love <fx@gnu.org>
parents:
diff changeset
798 @cindex yahrzeits
Dave Love <fx@gnu.org>
parents:
diff changeset
799 One common question concerning the Hebrew calendar is the computation
Dave Love <fx@gnu.org>
parents:
diff changeset
800 of the anniversary of a date of death, called a ``yahrzeit.'' The Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
801 calendar includes a facility for such calculations. If you are in the
Dave Love <fx@gnu.org>
parents:
diff changeset
802 calendar, the command @kbd{M-x list-yahrzeit-dates} asks you for a
Dave Love <fx@gnu.org>
parents:
diff changeset
803 range of years and then displays a list of the yahrzeit dates for those
Dave Love <fx@gnu.org>
parents:
diff changeset
804 years for the date given by point. If you are not in the calendar,
Dave Love <fx@gnu.org>
parents:
diff changeset
805 this command first asks you for the date of death and the range of
Dave Love <fx@gnu.org>
parents:
diff changeset
806 years, and then displays the list of yahrzeit dates.
Dave Love <fx@gnu.org>
parents:
diff changeset
807
Dave Love <fx@gnu.org>
parents:
diff changeset
808 @node Mayan Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
809 @subsection Converting from the Mayan Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
810
Dave Love <fx@gnu.org>
parents:
diff changeset
811 Here are the commands to select dates based on the Mayan calendar:
Dave Love <fx@gnu.org>
parents:
diff changeset
812
Dave Love <fx@gnu.org>
parents:
diff changeset
813 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
814 @item g m l
Dave Love <fx@gnu.org>
parents:
diff changeset
815 Move to a date specified by the long count calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
816 (@code{calendar-goto-mayan-long-count-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
817 @item g m n t
Dave Love <fx@gnu.org>
parents:
diff changeset
818 Move to the next occurrence of a place in the
Dave Love <fx@gnu.org>
parents:
diff changeset
819 tzolkin calendar (@code{calendar-next-tzolkin-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
820 @item g m p t
Dave Love <fx@gnu.org>
parents:
diff changeset
821 Move to the previous occurrence of a place in the
Dave Love <fx@gnu.org>
parents:
diff changeset
822 tzolkin calendar (@code{calendar-previous-tzolkin-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
823 @item g m n h
Dave Love <fx@gnu.org>
parents:
diff changeset
824 Move to the next occurrence of a place in the
Dave Love <fx@gnu.org>
parents:
diff changeset
825 haab calendar (@code{calendar-next-haab-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
826 @item g m p h
Dave Love <fx@gnu.org>
parents:
diff changeset
827 Move to the previous occurrence of a place in the
Dave Love <fx@gnu.org>
parents:
diff changeset
828 haab calendar (@code{calendar-previous-haab-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
829 @item g m n c
Dave Love <fx@gnu.org>
parents:
diff changeset
830 Move to the next occurrence of a place in the
Dave Love <fx@gnu.org>
parents:
diff changeset
831 calendar round (@code{calendar-next-calendar-round-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
832 @item g m p c
Dave Love <fx@gnu.org>
parents:
diff changeset
833 Move to the previous occurrence of a place in the
Dave Love <fx@gnu.org>
parents:
diff changeset
834 calendar round (@code{calendar-previous-calendar-round-date}).
Dave Love <fx@gnu.org>
parents:
diff changeset
835 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
836
Dave Love <fx@gnu.org>
parents:
diff changeset
837 @cindex Mayan long count
Dave Love <fx@gnu.org>
parents:
diff changeset
838 To understand these commands, you need to understand the Mayan calendars.
Dave Love <fx@gnu.org>
parents:
diff changeset
839 The @dfn{long count} is a counting of days with these units:
Dave Love <fx@gnu.org>
parents:
diff changeset
840
Dave Love <fx@gnu.org>
parents:
diff changeset
841 @display
Dave Love <fx@gnu.org>
parents:
diff changeset
842 1 kin = 1 day@ @ @ 1 uinal = 20 kin@ @ @ 1 tun = 18 uinal
Dave Love <fx@gnu.org>
parents:
diff changeset
843 1 katun = 20 tun@ @ @ 1 baktun = 20 katun
Dave Love <fx@gnu.org>
parents:
diff changeset
844 @end display
Dave Love <fx@gnu.org>
parents:
diff changeset
845
Dave Love <fx@gnu.org>
parents:
diff changeset
846 @kindex g m @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
847 @findex calendar-goto-mayan-long-count-date
Dave Love <fx@gnu.org>
parents:
diff changeset
848 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
849 Thus, the long count date 12.16.11.16.6 means 12 baktun, 16 katun, 11
Dave Love <fx@gnu.org>
parents:
diff changeset
850 tun, 16 uinal, and 6 kin. The Emacs calendar can handle Mayan long
Dave Love <fx@gnu.org>
parents:
diff changeset
851 count dates as early as 7.17.18.13.1, but no earlier. When you use the
Dave Love <fx@gnu.org>
parents:
diff changeset
852 @kbd{g m l} command, type the Mayan long count date with the baktun,
Dave Love <fx@gnu.org>
parents:
diff changeset
853 katun, tun, uinal, and kin separated by periods.
Dave Love <fx@gnu.org>
parents:
diff changeset
854
Dave Love <fx@gnu.org>
parents:
diff changeset
855 @findex calendar-previous-tzolkin-date
Dave Love <fx@gnu.org>
parents:
diff changeset
856 @findex calendar-next-tzolkin-date
Dave Love <fx@gnu.org>
parents:
diff changeset
857 @cindex Mayan tzolkin calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
858 The Mayan tzolkin calendar is a cycle of 260 days formed by a pair of
Dave Love <fx@gnu.org>
parents:
diff changeset
859 independent cycles of 13 and 20 days. Since this cycle repeats
Dave Love <fx@gnu.org>
parents:
diff changeset
860 endlessly, Emacs provides commands to move backward and forward to the
Dave Love <fx@gnu.org>
parents:
diff changeset
861 previous or next point in the cycle. Type @kbd{g m p t} to go to the
Dave Love <fx@gnu.org>
parents:
diff changeset
862 previous tzolkin date; Emacs asks you for a tzolkin date and moves point
Dave Love <fx@gnu.org>
parents:
diff changeset
863 to the previous occurrence of that date. Similarly, type @kbd{g m n t}
Dave Love <fx@gnu.org>
parents:
diff changeset
864 to go to the next occurrence of a tzolkin date.
Dave Love <fx@gnu.org>
parents:
diff changeset
865
Dave Love <fx@gnu.org>
parents:
diff changeset
866 @findex calendar-previous-haab-date
Dave Love <fx@gnu.org>
parents:
diff changeset
867 @findex calendar-next-haab-date
Dave Love <fx@gnu.org>
parents:
diff changeset
868 @cindex Mayan haab calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
869 The Mayan haab calendar is a cycle of 365 days arranged as 18 months
Dave Love <fx@gnu.org>
parents:
diff changeset
870 of 20 days each, followed a 5-day monthless period. Like the tzolkin
Dave Love <fx@gnu.org>
parents:
diff changeset
871 cycle, this cycle repeats endlessly, and there are commands to move
Dave Love <fx@gnu.org>
parents:
diff changeset
872 backward and forward to the previous or next point in the cycle. Type
Dave Love <fx@gnu.org>
parents:
diff changeset
873 @kbd{g m p h} to go to the previous haab date; Emacs asks you for a haab
Dave Love <fx@gnu.org>
parents:
diff changeset
874 date and moves point to the previous occurrence of that date.
Dave Love <fx@gnu.org>
parents:
diff changeset
875 Similarly, type @kbd{g m n h} to go to the next occurrence of a haab
Dave Love <fx@gnu.org>
parents:
diff changeset
876 date.
Dave Love <fx@gnu.org>
parents:
diff changeset
877
Dave Love <fx@gnu.org>
parents:
diff changeset
878 @c This is omitted because it is too long for smallbook format.
Dave Love <fx@gnu.org>
parents:
diff changeset
879 @c @findex calendar-previous-calendar-round-date
Dave Love <fx@gnu.org>
parents:
diff changeset
880 @findex calendar-next-calendar-round-date
Dave Love <fx@gnu.org>
parents:
diff changeset
881 @cindex Mayan calendar round
Dave Love <fx@gnu.org>
parents:
diff changeset
882 The Maya also used the combination of the tzolkin date and the haab
Dave Love <fx@gnu.org>
parents:
diff changeset
883 date. This combination is a cycle of about 52 years called a
Dave Love <fx@gnu.org>
parents:
diff changeset
884 @emph{calendar round}. If you type @kbd{g m p c}, Emacs asks you for
Dave Love <fx@gnu.org>
parents:
diff changeset
885 both a haab and a tzolkin date and then moves point to the previous
Dave Love <fx@gnu.org>
parents:
diff changeset
886 occurrence of that combination. Use @kbd{g m n c} to move point to the
Dave Love <fx@gnu.org>
parents:
diff changeset
887 next occurrence of a combination. These commands signal an error if the
Dave Love <fx@gnu.org>
parents:
diff changeset
888 haab/tzolkin date combination you have typed is impossible.
Dave Love <fx@gnu.org>
parents:
diff changeset
889
Dave Love <fx@gnu.org>
parents:
diff changeset
890 Emacs uses strict completion (@pxref{Strict Completion}) whenever it
Dave Love <fx@gnu.org>
parents:
diff changeset
891 asks you to type a Mayan name, so you don't have to worry about
Dave Love <fx@gnu.org>
parents:
diff changeset
892 spelling.
Dave Love <fx@gnu.org>
parents:
diff changeset
893
Dave Love <fx@gnu.org>
parents:
diff changeset
894 @node Diary
Dave Love <fx@gnu.org>
parents:
diff changeset
895 @section The Diary
Dave Love <fx@gnu.org>
parents:
diff changeset
896 @cindex diary
Dave Love <fx@gnu.org>
parents:
diff changeset
897
Dave Love <fx@gnu.org>
parents:
diff changeset
898 The Emacs diary keeps track of appointments or other events on a daily
Dave Love <fx@gnu.org>
parents:
diff changeset
899 basis, in conjunction with the calendar. To use the diary feature, you
Dave Love <fx@gnu.org>
parents:
diff changeset
900 must first create a @dfn{diary file} containing a list of events and
Dave Love <fx@gnu.org>
parents:
diff changeset
901 their dates. Then Emacs can automatically pick out and display the
Dave Love <fx@gnu.org>
parents:
diff changeset
902 events for today, for the immediate future, or for any specified
Dave Love <fx@gnu.org>
parents:
diff changeset
903 date.
Dave Love <fx@gnu.org>
parents:
diff changeset
904
Dave Love <fx@gnu.org>
parents:
diff changeset
905 By default, Emacs uses @file{~/diary} as the diary file. This is the
Dave Love <fx@gnu.org>
parents:
diff changeset
906 same file that the @code{calendar} utility uses. A sample
Dave Love <fx@gnu.org>
parents:
diff changeset
907 @file{~/diary} file is:
Dave Love <fx@gnu.org>
parents:
diff changeset
908
Dave Love <fx@gnu.org>
parents:
diff changeset
909 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
910 12/22/1988 Twentieth wedding anniversary!!
Dave Love <fx@gnu.org>
parents:
diff changeset
911 &1/1. Happy New Year!
Dave Love <fx@gnu.org>
parents:
diff changeset
912 10/22 Ruth's birthday.
Dave Love <fx@gnu.org>
parents:
diff changeset
913 * 21, *: Payday
Dave Love <fx@gnu.org>
parents:
diff changeset
914 Tuesday--weekly meeting with grad students at 10am
Dave Love <fx@gnu.org>
parents:
diff changeset
915 Supowit, Shen, Bitner, and Kapoor to attend.
Dave Love <fx@gnu.org>
parents:
diff changeset
916 1/13/89 Friday the thirteenth!!
Dave Love <fx@gnu.org>
parents:
diff changeset
917 &thu 4pm squash game with Lloyd.
Dave Love <fx@gnu.org>
parents:
diff changeset
918 mar 16 Dad's birthday
Dave Love <fx@gnu.org>
parents:
diff changeset
919 April 15, 1989 Income tax due.
Dave Love <fx@gnu.org>
parents:
diff changeset
920 &* 15 time cards due.
Dave Love <fx@gnu.org>
parents:
diff changeset
921 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
922
Dave Love <fx@gnu.org>
parents:
diff changeset
923 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
924 This example uses extra spaces to align the event descriptions of most
Dave Love <fx@gnu.org>
parents:
diff changeset
925 of the entries. Such formatting is purely a matter of taste.
Dave Love <fx@gnu.org>
parents:
diff changeset
926
Dave Love <fx@gnu.org>
parents:
diff changeset
927 Although you probably will start by creating a diary manually, Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
928 provides a number of commands to let you view, add, and change diary
Dave Love <fx@gnu.org>
parents:
diff changeset
929 entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
930
Dave Love <fx@gnu.org>
parents:
diff changeset
931 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
932 * Diary Commands:: Viewing diary entries and associated calendar dates.
Dave Love <fx@gnu.org>
parents:
diff changeset
933 * Format of Diary File:: Entering events in your diary.
Dave Love <fx@gnu.org>
parents:
diff changeset
934 * Date Formats:: Various ways you can specify dates.
Dave Love <fx@gnu.org>
parents:
diff changeset
935 * Adding to Diary:: Commands to create diary entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
936 * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
937 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
938
Dave Love <fx@gnu.org>
parents:
diff changeset
939 @node Diary Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
940 @subsection Commands Displaying Diary Entries
Dave Love <fx@gnu.org>
parents:
diff changeset
941
Dave Love <fx@gnu.org>
parents:
diff changeset
942 Once you have created a @file{~/diary} file, you can use the calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
943 to view it. You can also view today's events outside of Calendar mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
944
Dave Love <fx@gnu.org>
parents:
diff changeset
945 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
946 @item d
Dave Love <fx@gnu.org>
parents:
diff changeset
947 Display all diary entries for the selected date
Dave Love <fx@gnu.org>
parents:
diff changeset
948 (@code{view-diary-entries}).
Dave Love <fx@gnu.org>
parents:
diff changeset
949 @item Mouse-2 Diary
Dave Love <fx@gnu.org>
parents:
diff changeset
950 Display all diary entries for the date you click on.
Dave Love <fx@gnu.org>
parents:
diff changeset
951 @item s
Dave Love <fx@gnu.org>
parents:
diff changeset
952 Display the entire diary file (@code{show-all-diary-entries}).
Dave Love <fx@gnu.org>
parents:
diff changeset
953 @item m
Dave Love <fx@gnu.org>
parents:
diff changeset
954 Mark all visible dates that have diary entries
Dave Love <fx@gnu.org>
parents:
diff changeset
955 (@code{mark-diary-entries}).
Dave Love <fx@gnu.org>
parents:
diff changeset
956 @item u
Dave Love <fx@gnu.org>
parents:
diff changeset
957 Unmark the calendar window (@code{calendar-unmark}).
Dave Love <fx@gnu.org>
parents:
diff changeset
958 @item M-x print-diary-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
959 Print hard copy of the diary display as it appears.
Dave Love <fx@gnu.org>
parents:
diff changeset
960 @item M-x diary
Dave Love <fx@gnu.org>
parents:
diff changeset
961 Display all diary entries for today's date.
Dave Love <fx@gnu.org>
parents:
diff changeset
962 @item M-x diary-mail-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
963 Mail yourself email reminders about upcoming diary entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
964 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
965
Dave Love <fx@gnu.org>
parents:
diff changeset
966 @kindex d @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
967 @findex view-diary-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
968 Displaying the diary entries with @kbd{d} shows in a separate window
Dave Love <fx@gnu.org>
parents:
diff changeset
969 the diary entries for the selected date in the calendar. The mode line
Dave Love <fx@gnu.org>
parents:
diff changeset
970 of the new window shows the date of the diary entries and any holidays
Dave Love <fx@gnu.org>
parents:
diff changeset
971 that fall on that date. If you specify a numeric argument with @kbd{d},
Dave Love <fx@gnu.org>
parents:
diff changeset
972 it shows all the diary entries for that many successive days. Thus,
Dave Love <fx@gnu.org>
parents:
diff changeset
973 @kbd{2 d} displays all the entries for the selected date and for the
Dave Love <fx@gnu.org>
parents:
diff changeset
974 following day.
Dave Love <fx@gnu.org>
parents:
diff changeset
975
Dave Love <fx@gnu.org>
parents:
diff changeset
976 Another way to display the diary entries for a date is to click
37709
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
977 @kbd{Mouse-2} on the date, and then choose @kbd{Diary entries} from
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
978 the menu that appears.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
979
Dave Love <fx@gnu.org>
parents:
diff changeset
980 @kindex m @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
981 @findex mark-diary-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
982 To get a broader view of which days are mentioned in the diary, use
Dave Love <fx@gnu.org>
parents:
diff changeset
983 the @kbd{m} command. This displays the dates that have diary entries
Dave Love <fx@gnu.org>
parents:
diff changeset
984 in a different face (or places a @samp{+} after these dates, if
Dave Love <fx@gnu.org>
parents:
diff changeset
985 display with multiple faces is not available). The command applies both
Dave Love <fx@gnu.org>
parents:
diff changeset
986 to the currently visible months and to other months that subsequently
Dave Love <fx@gnu.org>
parents:
diff changeset
987 become visible by scrolling. To turn marking off and erase the current
Dave Love <fx@gnu.org>
parents:
diff changeset
988 marks, type @kbd{u}, which also turns off holiday marks
Dave Love <fx@gnu.org>
parents:
diff changeset
989 (@pxref{Holidays}).
Dave Love <fx@gnu.org>
parents:
diff changeset
990
Dave Love <fx@gnu.org>
parents:
diff changeset
991 @kindex s @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
992 @findex show-all-diary-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
993 To see the full diary file, rather than just some of the entries, use
Dave Love <fx@gnu.org>
parents:
diff changeset
994 the @kbd{s} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
995
Dave Love <fx@gnu.org>
parents:
diff changeset
996 Display of selected diary entries uses the selective display feature
Dave Love <fx@gnu.org>
parents:
diff changeset
997 to hide entries that don't apply.
Dave Love <fx@gnu.org>
parents:
diff changeset
998
Dave Love <fx@gnu.org>
parents:
diff changeset
999 The diary buffer as you see it is an illusion, so simply printing the
Dave Love <fx@gnu.org>
parents:
diff changeset
1000 buffer does not print what you see on your screen. There is a special
Dave Love <fx@gnu.org>
parents:
diff changeset
1001 command to print hard copy of the diary buffer @emph{as it appears};
Dave Love <fx@gnu.org>
parents:
diff changeset
1002 this command is @kbd{M-x print-diary-entries}. It sends the data
Dave Love <fx@gnu.org>
parents:
diff changeset
1003 directly to the printer. You can customize it like @code{lpr-region}
Dave Love <fx@gnu.org>
parents:
diff changeset
1004 (@pxref{Hardcopy}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1005
Dave Love <fx@gnu.org>
parents:
diff changeset
1006 @findex diary
Dave Love <fx@gnu.org>
parents:
diff changeset
1007 The command @kbd{M-x diary} displays the diary entries for the current
Dave Love <fx@gnu.org>
parents:
diff changeset
1008 date, independently of the calendar display, and optionally for the next
Dave Love <fx@gnu.org>
parents:
diff changeset
1009 few days as well; the variable @code{number-of-diary-entries} specifies
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 how many days to include. @xref{Calendar, Customizing the Calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 and Diary,, elisp, The Emacs Lisp Reference Manual}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1012
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 If you put @code{(diary)} in your @file{.emacs} file, this
Dave Love <fx@gnu.org>
parents:
diff changeset
1014 automatically displays a window with the day's diary entries, when you
Dave Love <fx@gnu.org>
parents:
diff changeset
1015 enter Emacs. The mode line of the displayed window shows the date and
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 any holidays that fall on that date.
Dave Love <fx@gnu.org>
parents:
diff changeset
1017
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 @findex diary-mail-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 @vindex diary-mail-days
Dave Love <fx@gnu.org>
parents:
diff changeset
1020 Many users like to receive notice of events in their diary as email.
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 To send such mail to yourself, use the command @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
1022 diary-mail-entries}. A prefix argument specifies how many days
Dave Love <fx@gnu.org>
parents:
diff changeset
1023 (starting with today) to check; otherwise, the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 @code{diary-mail-days} says how many days.
Dave Love <fx@gnu.org>
parents:
diff changeset
1025
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 @node Format of Diary File
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 @subsection The Diary File
Dave Love <fx@gnu.org>
parents:
diff changeset
1028 @cindex diary file
Dave Love <fx@gnu.org>
parents:
diff changeset
1029
Dave Love <fx@gnu.org>
parents:
diff changeset
1030 @vindex diary-file
Dave Love <fx@gnu.org>
parents:
diff changeset
1031 Your @dfn{diary file} is a file that records events associated with
Dave Love <fx@gnu.org>
parents:
diff changeset
1032 particular dates. The name of the diary file is specified by the
Dave Love <fx@gnu.org>
parents:
diff changeset
1033 variable @code{diary-file}; @file{~/diary} is the default. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1034 @code{calendar} utility program supports a subset of the format allowed
Dave Love <fx@gnu.org>
parents:
diff changeset
1035 by the Emacs diary facilities, so you can use that utility to view the
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 diary file, with reasonable results aside from the entries it cannot
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 understand.
Dave Love <fx@gnu.org>
parents:
diff changeset
1038
Dave Love <fx@gnu.org>
parents:
diff changeset
1039 Each entry in the diary file describes one event and consists of one
Dave Love <fx@gnu.org>
parents:
diff changeset
1040 or more lines. An entry always begins with a date specification at the
Dave Love <fx@gnu.org>
parents:
diff changeset
1041 left margin. The rest of the entry is simply text to describe the
Dave Love <fx@gnu.org>
parents:
diff changeset
1042 event. If the entry has more than one line, then the lines after the
Dave Love <fx@gnu.org>
parents:
diff changeset
1043 first must begin with whitespace to indicate they continue a previous
Dave Love <fx@gnu.org>
parents:
diff changeset
1044 entry. Lines that do not begin with valid dates and do not continue a
Dave Love <fx@gnu.org>
parents:
diff changeset
1045 preceding entry are ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
1046
Dave Love <fx@gnu.org>
parents:
diff changeset
1047 You can inhibit the marking of certain diary entries in the calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
1048 window; to do this, insert an ampersand (@samp{&}) at the beginning of
Dave Love <fx@gnu.org>
parents:
diff changeset
1049 the entry, before the date. This has no effect on display of the entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 in the diary window; it affects only marks on dates in the calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
1051 window. Nonmarking entries are especially useful for generic entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1052 that would otherwise mark many different dates.
Dave Love <fx@gnu.org>
parents:
diff changeset
1053
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 If the first line of a diary entry consists only of the date or day
Dave Love <fx@gnu.org>
parents:
diff changeset
1055 name with no following blanks or punctuation, then the diary window
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 display doesn't include that line; only the continuation lines appear.
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 For example, this entry:
Dave Love <fx@gnu.org>
parents:
diff changeset
1058
Dave Love <fx@gnu.org>
parents:
diff changeset
1059 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1060 02/11/1989
Dave Love <fx@gnu.org>
parents:
diff changeset
1061 Bill B. visits Princeton today
Dave Love <fx@gnu.org>
parents:
diff changeset
1062 2pm Cognitive Studies Committee meeting
Dave Love <fx@gnu.org>
parents:
diff changeset
1063 2:30-5:30 Liz at Lawrenceville
Dave Love <fx@gnu.org>
parents:
diff changeset
1064 4:00pm Dentist appt
Dave Love <fx@gnu.org>
parents:
diff changeset
1065 7:30pm Dinner at George's
Dave Love <fx@gnu.org>
parents:
diff changeset
1066 8:00-10:00pm concert
Dave Love <fx@gnu.org>
parents:
diff changeset
1067 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1068
Dave Love <fx@gnu.org>
parents:
diff changeset
1069 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1070 appears in the diary window without the date line at the beginning.
Dave Love <fx@gnu.org>
parents:
diff changeset
1071 This style of entry looks neater when you display just a single day's
Dave Love <fx@gnu.org>
parents:
diff changeset
1072 entries, but can cause confusion if you ask for more than one day's
Dave Love <fx@gnu.org>
parents:
diff changeset
1073 entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
1074
Dave Love <fx@gnu.org>
parents:
diff changeset
1075 You can edit the diary entries as they appear in the window, but it is
Dave Love <fx@gnu.org>
parents:
diff changeset
1076 important to remember that the buffer displayed contains the @emph{entire}
Dave Love <fx@gnu.org>
parents:
diff changeset
1077 diary file, with portions of it concealed from view. This means, for
Dave Love <fx@gnu.org>
parents:
diff changeset
1078 instance, that the @kbd{C-f} (@code{forward-char}) command can put point
Dave Love <fx@gnu.org>
parents:
diff changeset
1079 at what appears to be the end of the line, but what is in reality the
Dave Love <fx@gnu.org>
parents:
diff changeset
1080 middle of some concealed line.
Dave Love <fx@gnu.org>
parents:
diff changeset
1081
Dave Love <fx@gnu.org>
parents:
diff changeset
1082 @emph{Be careful when editing the diary entries!} Inserting
Dave Love <fx@gnu.org>
parents:
diff changeset
1083 additional lines or adding/deleting characters in the middle of a
Dave Love <fx@gnu.org>
parents:
diff changeset
1084 visible line cannot cause problems, but editing at the end of a line may
Dave Love <fx@gnu.org>
parents:
diff changeset
1085 not do what you expect. Deleting a line may delete other invisible
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 entries that follow it. Before editing the diary, it is best to display
Dave Love <fx@gnu.org>
parents:
diff changeset
1087 the entire file with @kbd{s} (@code{show-all-diary-entries}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1088
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 @node Date Formats
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 @subsection Date Formats
Dave Love <fx@gnu.org>
parents:
diff changeset
1091
Dave Love <fx@gnu.org>
parents:
diff changeset
1092 Here are some sample diary entries, illustrating different ways of
Dave Love <fx@gnu.org>
parents:
diff changeset
1093 formatting a date. The examples all show dates in American order
Dave Love <fx@gnu.org>
parents:
diff changeset
1094 (month, day, year), but Calendar mode supports European order (day,
Dave Love <fx@gnu.org>
parents:
diff changeset
1095 month, year) as an option.
Dave Love <fx@gnu.org>
parents:
diff changeset
1096
Dave Love <fx@gnu.org>
parents:
diff changeset
1097 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1098 4/20/93 Switch-over to new tabulation system
Dave Love <fx@gnu.org>
parents:
diff changeset
1099 apr. 25 Start tabulating annual results
Dave Love <fx@gnu.org>
parents:
diff changeset
1100 4/30 Results for April are due
Dave Love <fx@gnu.org>
parents:
diff changeset
1101 */25 Monthly cycle finishes
Dave Love <fx@gnu.org>
parents:
diff changeset
1102 Friday Don't leave without backing up files
Dave Love <fx@gnu.org>
parents:
diff changeset
1103 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1104
Dave Love <fx@gnu.org>
parents:
diff changeset
1105 The first entry appears only once, on April 20, 1993. The second and
Dave Love <fx@gnu.org>
parents:
diff changeset
1106 third appear every year on the specified dates, and the fourth uses a
Dave Love <fx@gnu.org>
parents:
diff changeset
1107 wildcard (asterisk) for the month, so it appears on the 25th of every
Dave Love <fx@gnu.org>
parents:
diff changeset
1108 month. The final entry appears every week on Friday.
Dave Love <fx@gnu.org>
parents:
diff changeset
1109
Dave Love <fx@gnu.org>
parents:
diff changeset
1110 You can use just numbers to express a date, as in
Dave Love <fx@gnu.org>
parents:
diff changeset
1111 @samp{@var{month}/@var{day}} or @samp{@var{month}/@var{day}/@var{year}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1112 This must be followed by a nondigit. In the date itself, @var{month}
Dave Love <fx@gnu.org>
parents:
diff changeset
1113 and @var{day} are numbers of one or two digits. The optional @var{year}
Dave Love <fx@gnu.org>
parents:
diff changeset
1114 is also a number, and may be abbreviated to the last two digits; that
Dave Love <fx@gnu.org>
parents:
diff changeset
1115 is, you can use @samp{11/12/1989} or @samp{11/12/89}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1116
Dave Love <fx@gnu.org>
parents:
diff changeset
1117 Dates can also have the form @samp{@var{monthname} @var{day}} or
Dave Love <fx@gnu.org>
parents:
diff changeset
1118 @samp{@var{monthname} @var{day}, @var{year}}, where the month's name can
52120
d03db605b057 (Date Formats): Document changed behaviour of abbreviations.
Glenn Morris <rgm@gnu.org>
parents: 49600
diff changeset
1119 be spelled in full or abbreviated (with or without a period). The
d03db605b057 (Date Formats): Document changed behaviour of abbreviations.
Glenn Morris <rgm@gnu.org>
parents: 49600
diff changeset
1120 preferred abbreviations can be controlled using the variables
d03db605b057 (Date Formats): Document changed behaviour of abbreviations.
Glenn Morris <rgm@gnu.org>
parents: 49600
diff changeset
1121 @code{calendar-abbrev-length}, @code{calendar-month-abbrev-array}, and
d03db605b057 (Date Formats): Document changed behaviour of abbreviations.
Glenn Morris <rgm@gnu.org>
parents: 49600
diff changeset
1122 @code{calendar-day-abbrev-array}. The default is to use the first three
d03db605b057 (Date Formats): Document changed behaviour of abbreviations.
Glenn Morris <rgm@gnu.org>
parents: 49600
diff changeset
1123 letters of a name as its abbreviation. Case is not significant.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1124
Dave Love <fx@gnu.org>
parents:
diff changeset
1125 A date may be @dfn{generic}; that is, partially unspecified. Then the
Dave Love <fx@gnu.org>
parents:
diff changeset
1126 entry applies to all dates that match the specification. If the date
Dave Love <fx@gnu.org>
parents:
diff changeset
1127 does not contain a year, it is generic and applies to any year.
Dave Love <fx@gnu.org>
parents:
diff changeset
1128 Alternatively, @var{month}, @var{day}, or @var{year} can be a @samp{*};
Dave Love <fx@gnu.org>
parents:
diff changeset
1129 this matches any month, day, or year, respectively. Thus, a diary entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1130 @samp{3/*/*} matches any day in March of any year; so does @samp{march
Dave Love <fx@gnu.org>
parents:
diff changeset
1131 *}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1132
Dave Love <fx@gnu.org>
parents:
diff changeset
1133 @vindex european-calendar-style
Dave Love <fx@gnu.org>
parents:
diff changeset
1134 @findex european-calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
1135 @findex american-calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
1136 If you prefer the European style of writing dates---in which the day
Dave Love <fx@gnu.org>
parents:
diff changeset
1137 comes before the month---type @kbd{M-x european-calendar} while in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1138 calendar, or set the variable @code{european-calendar-style} to @code{t}
Dave Love <fx@gnu.org>
parents:
diff changeset
1139 @emph{before} using any calendar or diary command. This mode interprets
Dave Love <fx@gnu.org>
parents:
diff changeset
1140 all dates in the diary in the European manner, and also uses European
Dave Love <fx@gnu.org>
parents:
diff changeset
1141 style for displaying diary dates. (Note that there is no comma after
Dave Love <fx@gnu.org>
parents:
diff changeset
1142 the @var{monthname} in the European style.) To go back to the (default)
Dave Love <fx@gnu.org>
parents:
diff changeset
1143 American style of writing dates, type @kbd{M-x american-calendar}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1144
Dave Love <fx@gnu.org>
parents:
diff changeset
1145 You can use the name of a day of the week as a generic date which
Dave Love <fx@gnu.org>
parents:
diff changeset
1146 applies to any date falling on that day of the week. You can abbreviate
Dave Love <fx@gnu.org>
parents:
diff changeset
1147 the day of the week to three letters (with or without a period) or spell
Dave Love <fx@gnu.org>
parents:
diff changeset
1148 it in full; case is not significant.
Dave Love <fx@gnu.org>
parents:
diff changeset
1149
Dave Love <fx@gnu.org>
parents:
diff changeset
1150 @node Adding to Diary
Dave Love <fx@gnu.org>
parents:
diff changeset
1151 @subsection Commands to Add to the Diary
Dave Love <fx@gnu.org>
parents:
diff changeset
1152
Dave Love <fx@gnu.org>
parents:
diff changeset
1153 While in the calendar, there are several commands to create diary
Dave Love <fx@gnu.org>
parents:
diff changeset
1154 entries:
Dave Love <fx@gnu.org>
parents:
diff changeset
1155
Dave Love <fx@gnu.org>
parents:
diff changeset
1156 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1157 @item i d
Dave Love <fx@gnu.org>
parents:
diff changeset
1158 Add a diary entry for the selected date (@code{insert-diary-entry}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1159 @item i w
Dave Love <fx@gnu.org>
parents:
diff changeset
1160 Add a diary entry for the selected day of the week (@code{insert-weekly-diary-entry}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1161 @item i m
Dave Love <fx@gnu.org>
parents:
diff changeset
1162 Add a diary entry for the selected day of the month (@code{insert-monthly-diary-entry}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1163 @item i y
Dave Love <fx@gnu.org>
parents:
diff changeset
1164 Add a diary entry for the selected day of the year (@code{insert-yearly-diary-entry}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1165 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1166
Dave Love <fx@gnu.org>
parents:
diff changeset
1167 @kindex i d @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1168 @findex insert-diary-entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1169 You can make a diary entry for a specific date by selecting that date
Dave Love <fx@gnu.org>
parents:
diff changeset
1170 in the calendar window and typing the @kbd{i d} command. This command
Dave Love <fx@gnu.org>
parents:
diff changeset
1171 displays the end of your diary file in another window and inserts the
Dave Love <fx@gnu.org>
parents:
diff changeset
1172 date; you can then type the rest of the diary entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1173
Dave Love <fx@gnu.org>
parents:
diff changeset
1174 @kindex i w @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1175 @findex insert-weekly-diary-entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1176 @kindex i m @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1177 @findex insert-monthly-diary-entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1178 @kindex i y @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1179 @findex insert-yearly-diary-entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1180 If you want to make a diary entry that applies to a specific day of
Dave Love <fx@gnu.org>
parents:
diff changeset
1181 the week, select that day of the week (any occurrence will do) and type
Dave Love <fx@gnu.org>
parents:
diff changeset
1182 @kbd{i w}. This inserts the day-of-week as a generic date; you can then
Dave Love <fx@gnu.org>
parents:
diff changeset
1183 type the rest of the diary entry. You can make a monthly diary entry in
38125
8bca08a060e8 Proofreading changes from Tim Goodwin <tjg@star.le.ac.uk>.
Eli Zaretskii <eliz@gnu.org>
parents: 37709
diff changeset
1184 the same fashion: select the day of the month, use the @kbd{i m}
8bca08a060e8 Proofreading changes from Tim Goodwin <tjg@star.le.ac.uk>.
Eli Zaretskii <eliz@gnu.org>
parents: 37709
diff changeset
1185 command, and type the rest of the entry. Similarly, you can insert a
8bca08a060e8 Proofreading changes from Tim Goodwin <tjg@star.le.ac.uk>.
Eli Zaretskii <eliz@gnu.org>
parents: 37709
diff changeset
1186 yearly diary entry with the @kbd{i y} command.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1187
Dave Love <fx@gnu.org>
parents:
diff changeset
1188 All of the above commands make marking diary entries by default. To
Dave Love <fx@gnu.org>
parents:
diff changeset
1189 make a nonmarking diary entry, give a numeric argument to the command.
Dave Love <fx@gnu.org>
parents:
diff changeset
1190 For example, @kbd{C-u i w} makes a nonmarking weekly diary entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1191
Dave Love <fx@gnu.org>
parents:
diff changeset
1192 When you modify the diary file, be sure to save the file before
Dave Love <fx@gnu.org>
parents:
diff changeset
1193 exiting Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
1194
Dave Love <fx@gnu.org>
parents:
diff changeset
1195 @node Special Diary Entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1196 @subsection Special Diary Entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1197
Dave Love <fx@gnu.org>
parents:
diff changeset
1198 In addition to entries based on calendar dates, the diary file can
Dave Love <fx@gnu.org>
parents:
diff changeset
1199 contain @dfn{sexp entries} for regular events such as anniversaries.
Dave Love <fx@gnu.org>
parents:
diff changeset
1200 These entries are based on Lisp expressions (sexps) that Emacs evaluates
Dave Love <fx@gnu.org>
parents:
diff changeset
1201 as it scans the diary file. Instead of a date, a sexp entry contains
Dave Love <fx@gnu.org>
parents:
diff changeset
1202 @samp{%%} followed by a Lisp expression which must begin and end with
Dave Love <fx@gnu.org>
parents:
diff changeset
1203 parentheses. The Lisp expression determines which dates the entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1204 applies to.
Dave Love <fx@gnu.org>
parents:
diff changeset
1205
Dave Love <fx@gnu.org>
parents:
diff changeset
1206 Calendar mode provides commands to insert certain commonly used
Dave Love <fx@gnu.org>
parents:
diff changeset
1207 sexp entries:
Dave Love <fx@gnu.org>
parents:
diff changeset
1208
Dave Love <fx@gnu.org>
parents:
diff changeset
1209 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1210 @item i a
Dave Love <fx@gnu.org>
parents:
diff changeset
1211 Add an anniversary diary entry for the selected date
Dave Love <fx@gnu.org>
parents:
diff changeset
1212 (@code{insert-anniversary-diary-entry}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1213 @item i b
Dave Love <fx@gnu.org>
parents:
diff changeset
1214 Add a block diary entry for the current region
Dave Love <fx@gnu.org>
parents:
diff changeset
1215 (@code{insert-block-diary-entry}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1216 @item i c
Dave Love <fx@gnu.org>
parents:
diff changeset
1217 Add a cyclic diary entry starting at the date
Dave Love <fx@gnu.org>
parents:
diff changeset
1218 (@code{insert-cyclic-diary-entry}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1219 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1220
Dave Love <fx@gnu.org>
parents:
diff changeset
1221 @kindex i a @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1222 @findex insert-anniversary-diary-entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1223 If you want to make a diary entry that applies to the anniversary of a
Dave Love <fx@gnu.org>
parents:
diff changeset
1224 specific date, move point to that date and use the @kbd{i a} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
1225 This displays the end of your diary file in another window and inserts
Dave Love <fx@gnu.org>
parents:
diff changeset
1226 the anniversary description; you can then type the rest of the diary
Dave Love <fx@gnu.org>
parents:
diff changeset
1227 entry. The entry looks like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1228
Dave Love <fx@gnu.org>
parents:
diff changeset
1229 @findex diary-anniversary
Dave Love <fx@gnu.org>
parents:
diff changeset
1230 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1231 %%(diary-anniversary 10 31 1948) Arthur's birthday
Dave Love <fx@gnu.org>
parents:
diff changeset
1232 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1233
Dave Love <fx@gnu.org>
parents:
diff changeset
1234 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1235 This entry applies to October 31 in any year after 1948; @samp{10 31
Dave Love <fx@gnu.org>
parents:
diff changeset
1236 1948} specifies the date. (If you are using the European calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
1237 style, the month and day are interchanged.) The reason this expression
Dave Love <fx@gnu.org>
parents:
diff changeset
1238 requires a beginning year is that advanced diary functions can use it to
Dave Love <fx@gnu.org>
parents:
diff changeset
1239 calculate the number of elapsed years.
Dave Love <fx@gnu.org>
parents:
diff changeset
1240
Dave Love <fx@gnu.org>
parents:
diff changeset
1241 A @dfn{block} diary entry applies to a specified range of consecutive
Dave Love <fx@gnu.org>
parents:
diff changeset
1242 dates. Here is a block diary entry that applies to all dates from June
Dave Love <fx@gnu.org>
parents:
diff changeset
1243 24, 1990 through July 10, 1990:
Dave Love <fx@gnu.org>
parents:
diff changeset
1244
Dave Love <fx@gnu.org>
parents:
diff changeset
1245 @findex diary-block
Dave Love <fx@gnu.org>
parents:
diff changeset
1246 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1247 %%(diary-block 6 24 1990 7 10 1990) Vacation
Dave Love <fx@gnu.org>
parents:
diff changeset
1248 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1249
Dave Love <fx@gnu.org>
parents:
diff changeset
1250 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1251 The @samp{6 24 1990} indicates the starting date and the @samp{7 10 1990}
Dave Love <fx@gnu.org>
parents:
diff changeset
1252 indicates the stopping date. (Again, if you are using the European calendar
Dave Love <fx@gnu.org>
parents:
diff changeset
1253 style, the month and day are interchanged.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1254
Dave Love <fx@gnu.org>
parents:
diff changeset
1255 @kindex i b @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1256 @findex insert-block-diary-entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1257 To insert a block entry, place point and the mark on the two
Dave Love <fx@gnu.org>
parents:
diff changeset
1258 dates that begin and end the range, and type @kbd{i b}. This command
Dave Love <fx@gnu.org>
parents:
diff changeset
1259 displays the end of your diary file in another window and inserts the
Dave Love <fx@gnu.org>
parents:
diff changeset
1260 block description; you can then type the diary entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1261
Dave Love <fx@gnu.org>
parents:
diff changeset
1262 @kindex i c @r{(Calendar mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1263 @findex insert-cyclic-diary-entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1264 @dfn{Cyclic} diary entries repeat after a fixed interval of days. To
Dave Love <fx@gnu.org>
parents:
diff changeset
1265 create one, select the starting date and use the @kbd{i c} command. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1266 command prompts for the length of interval, then inserts the entry,
Dave Love <fx@gnu.org>
parents:
diff changeset
1267 which looks like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1268
Dave Love <fx@gnu.org>
parents:
diff changeset
1269 @findex diary-cyclic
Dave Love <fx@gnu.org>
parents:
diff changeset
1270 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1271 %%(diary-cyclic 50 3 1 1990) Renew medication
Dave Love <fx@gnu.org>
parents:
diff changeset
1272 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1273
Dave Love <fx@gnu.org>
parents:
diff changeset
1274 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1275 This entry applies to March 1, 1990 and every 50th day following;
Dave Love <fx@gnu.org>
parents:
diff changeset
1276 @samp{3 1 1990} specifies the starting date. (If you are using the
Dave Love <fx@gnu.org>
parents:
diff changeset
1277 European calendar style, the month and day are interchanged.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1278
Dave Love <fx@gnu.org>
parents:
diff changeset
1279 All three of these commands make marking diary entries. To insert a
Dave Love <fx@gnu.org>
parents:
diff changeset
1280 nonmarking entry, give a numeric argument to the command. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
1281 @kbd{C-u i a} makes a nonmarking anniversary diary entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1282
Dave Love <fx@gnu.org>
parents:
diff changeset
1283 Marking sexp diary entries in the calendar is @emph{extremely}
Dave Love <fx@gnu.org>
parents:
diff changeset
1284 time-consuming, since every date visible in the calendar window must be
Dave Love <fx@gnu.org>
parents:
diff changeset
1285 individually checked. So it's a good idea to make sexp diary entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1286 nonmarking (with @samp{&}) when possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
1287
Dave Love <fx@gnu.org>
parents:
diff changeset
1288 Another sophisticated kind of sexp entry, a @dfn{floating} diary entry,
Dave Love <fx@gnu.org>
parents:
diff changeset
1289 specifies a regularly occurring event by offsets specified in days,
Dave Love <fx@gnu.org>
parents:
diff changeset
1290 weeks, and months. It is comparable to a crontab entry interpreted by
Dave Love <fx@gnu.org>
parents:
diff changeset
1291 the @code{cron} utility. Here is a nonmarking, floating diary entry
Dave Love <fx@gnu.org>
parents:
diff changeset
1292 that applies to the last Thursday in November:
Dave Love <fx@gnu.org>
parents:
diff changeset
1293
Dave Love <fx@gnu.org>
parents:
diff changeset
1294 @findex diary-float
Dave Love <fx@gnu.org>
parents:
diff changeset
1295 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1296 &%%(diary-float 11 4 -1) American Thanksgiving
Dave Love <fx@gnu.org>
parents:
diff changeset
1297 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1298
Dave Love <fx@gnu.org>
parents:
diff changeset
1299 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1300 The 11 specifies November (the eleventh month), the 4 specifies Thursday
Dave Love <fx@gnu.org>
parents:
diff changeset
1301 (the fourth day of the week, where Sunday is numbered zero), and the
Dave Love <fx@gnu.org>
parents:
diff changeset
1302 @minus{}1 specifies ``last'' (1 would mean ``first,'' 2 would mean
Dave Love <fx@gnu.org>
parents:
diff changeset
1303 ``second,'' @minus{}2 would mean ``second-to-last,'' and so on). The
Dave Love <fx@gnu.org>
parents:
diff changeset
1304 month can be a single month or a list of months. Thus you could change
Dave Love <fx@gnu.org>
parents:
diff changeset
1305 the 11 above to @samp{'(1 2 3)} and have the entry apply to the last
Dave Love <fx@gnu.org>
parents:
diff changeset
1306 Thursday of January, February, and March. If the month is @code{t}, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1307 entry applies to all months of the year.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1308
46689
90b567ad02ed Sexp diary entries can specify how to highlight the date.
Richard M. Stallman <rms@gnu.org>
parents: 39287
diff changeset
1309 Each of the standard sexp diary entries takes an optional parameter
90b567ad02ed Sexp diary entries can specify how to highlight the date.
Richard M. Stallman <rms@gnu.org>
parents: 39287
diff changeset
1310 specifying the name of a face or a single-character string to use when
90b567ad02ed Sexp diary entries can specify how to highlight the date.
Richard M. Stallman <rms@gnu.org>
parents: 39287
diff changeset
1311 marking the entry in the calendar. Most generally, sexp diary entries
90b567ad02ed Sexp diary entries can specify how to highlight the date.
Richard M. Stallman <rms@gnu.org>
parents: 39287
diff changeset
1312 can perform arbitrary computations to determine when they apply.
90b567ad02ed Sexp diary entries can specify how to highlight the date.
Richard M. Stallman <rms@gnu.org>
parents: 39287
diff changeset
1313 @xref{Sexp Diary Entries,, Sexp Diary Entries, elisp, The Emacs Lisp
90b567ad02ed Sexp diary entries can specify how to highlight the date.
Richard M. Stallman <rms@gnu.org>
parents: 39287
diff changeset
1314 Reference Manual}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1315
Dave Love <fx@gnu.org>
parents:
diff changeset
1316 @node Appointments
Dave Love <fx@gnu.org>
parents:
diff changeset
1317 @section Appointments
Dave Love <fx@gnu.org>
parents:
diff changeset
1318 @cindex appointment notification
Dave Love <fx@gnu.org>
parents:
diff changeset
1319
Dave Love <fx@gnu.org>
parents:
diff changeset
1320 If you have a diary entry for an appointment, and that diary entry
38745
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38156
diff changeset
1321 begins with a recognizable time of day, Emacs can warn you several
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38156
diff changeset
1322 minutes beforehand that that appointment is pending. Emacs alerts you
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1323 to the appointment by displaying a message in the mode line.
Dave Love <fx@gnu.org>
parents:
diff changeset
1324
Dave Love <fx@gnu.org>
parents:
diff changeset
1325 @vindex diary-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1326 @findex appt-make-list
Dave Love <fx@gnu.org>
parents:
diff changeset
1327 To enable appointment notification, you must enable the time display
Dave Love <fx@gnu.org>
parents:
diff changeset
1328 feature of Emacs, @kbd{M-x display-time} (@pxref{Mode Line}). You must
Dave Love <fx@gnu.org>
parents:
diff changeset
1329 also add the function @code{appt-make-list} to the
Dave Love <fx@gnu.org>
parents:
diff changeset
1330 @code{diary-hook}, like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1331
Dave Love <fx@gnu.org>
parents:
diff changeset
1332 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1333 (add-hook 'diary-hook 'appt-make-list)
Dave Love <fx@gnu.org>
parents:
diff changeset
1334 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1335
Dave Love <fx@gnu.org>
parents:
diff changeset
1336 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1337 Adding this text to your @file{.emacs} file does the whole job:
Dave Love <fx@gnu.org>
parents:
diff changeset
1338
Dave Love <fx@gnu.org>
parents:
diff changeset
1339 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1340 (display-time)
Dave Love <fx@gnu.org>
parents:
diff changeset
1341 (add-hook 'diary-hook 'appt-make-list)
Dave Love <fx@gnu.org>
parents:
diff changeset
1342 (diary 0)
Dave Love <fx@gnu.org>
parents:
diff changeset
1343 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1344
Dave Love <fx@gnu.org>
parents:
diff changeset
1345 With these preparations done, when you display the diary (either with
Dave Love <fx@gnu.org>
parents:
diff changeset
1346 the @kbd{d} command in the calendar window or with the @kbd{M-x diary}
Dave Love <fx@gnu.org>
parents:
diff changeset
1347 command), it sets up an appointment list of all the diary entries found
Dave Love <fx@gnu.org>
parents:
diff changeset
1348 with recognizable times of day, and reminds you just before each of
Dave Love <fx@gnu.org>
parents:
diff changeset
1349 them.
Dave Love <fx@gnu.org>
parents:
diff changeset
1350
Dave Love <fx@gnu.org>
parents:
diff changeset
1351 For example, suppose the diary file contains these lines:
Dave Love <fx@gnu.org>
parents:
diff changeset
1352
Dave Love <fx@gnu.org>
parents:
diff changeset
1353 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1354 Monday
Dave Love <fx@gnu.org>
parents:
diff changeset
1355 9:30am Coffee break
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46689
diff changeset
1356 12:00pm Lunch
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1357 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1358
Dave Love <fx@gnu.org>
parents:
diff changeset
1359 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1360 Then on Mondays, after you have displayed the diary, you will be
Dave Love <fx@gnu.org>
parents:
diff changeset
1361 reminded at 9:20am about your coffee break and at 11:50am about lunch.
Dave Love <fx@gnu.org>
parents:
diff changeset
1362
Dave Love <fx@gnu.org>
parents:
diff changeset
1363 You can write times in am/pm style (with @samp{12:00am} standing
Dave Love <fx@gnu.org>
parents:
diff changeset
1364 for midnight and @samp{12:00pm} standing for noon), or 24-hour
Dave Love <fx@gnu.org>
parents:
diff changeset
1365 European/military style. You need not be consistent; your diary file
Dave Love <fx@gnu.org>
parents:
diff changeset
1366 can have a mixture of the two styles.
Dave Love <fx@gnu.org>
parents:
diff changeset
1367
Dave Love <fx@gnu.org>
parents:
diff changeset
1368 @vindex appt-display-diary
Dave Love <fx@gnu.org>
parents:
diff changeset
1369 Emacs updates the appointments list automatically just after
Dave Love <fx@gnu.org>
parents:
diff changeset
1370 midnight. This also displays the next day's diary entries in the diary
Dave Love <fx@gnu.org>
parents:
diff changeset
1371 buffer, unless you set @code{appt-display-diary} to @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1372
Dave Love <fx@gnu.org>
parents:
diff changeset
1373 @findex appt-add
Dave Love <fx@gnu.org>
parents:
diff changeset
1374 @findex appt-delete
Dave Love <fx@gnu.org>
parents:
diff changeset
1375 @cindex alarm clock
Dave Love <fx@gnu.org>
parents:
diff changeset
1376 You can also use the appointment notification facility like an alarm
Dave Love <fx@gnu.org>
parents:
diff changeset
1377 clock. The command @kbd{M-x appt-add} adds entries to the appointment
Dave Love <fx@gnu.org>
parents:
diff changeset
1378 list without affecting your diary file. You delete entries from the
Dave Love <fx@gnu.org>
parents:
diff changeset
1379 appointment list with @kbd{M-x appt-delete}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1380
Dave Love <fx@gnu.org>
parents:
diff changeset
1381 @vindex appt-issue-message
Dave Love <fx@gnu.org>
parents:
diff changeset
1382 You can turn off the appointment notification feature at any time by
Dave Love <fx@gnu.org>
parents:
diff changeset
1383 setting @code{appt-issue-message} to @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1384
Dave Love <fx@gnu.org>
parents:
diff changeset
1385 @node Daylight Savings
Dave Love <fx@gnu.org>
parents:
diff changeset
1386 @section Daylight Savings Time
Dave Love <fx@gnu.org>
parents:
diff changeset
1387 @cindex daylight savings time
Dave Love <fx@gnu.org>
parents:
diff changeset
1388
Dave Love <fx@gnu.org>
parents:
diff changeset
1389 Emacs understands the difference between standard time and daylight
Dave Love <fx@gnu.org>
parents:
diff changeset
1390 savings time---the times given for sunrise, sunset, solstices,
Dave Love <fx@gnu.org>
parents:
diff changeset
1391 equinoxes, and the phases of the moon take that into account. The rules
Dave Love <fx@gnu.org>
parents:
diff changeset
1392 for daylight savings time vary from place to place and have also varied
Dave Love <fx@gnu.org>
parents:
diff changeset
1393 historically from year to year. To do the job properly, Emacs needs to
Dave Love <fx@gnu.org>
parents:
diff changeset
1394 know which rules to use.
Dave Love <fx@gnu.org>
parents:
diff changeset
1395
Dave Love <fx@gnu.org>
parents:
diff changeset
1396 @vindex calendar-daylight-savings-starts
Dave Love <fx@gnu.org>
parents:
diff changeset
1397 @vindex calendar-daylight-savings-ends
Dave Love <fx@gnu.org>
parents:
diff changeset
1398 Some operating systems keep track of the rules that apply to the place
Dave Love <fx@gnu.org>
parents:
diff changeset
1399 where you are; on these systems, Emacs gets the information it needs
Dave Love <fx@gnu.org>
parents:
diff changeset
1400 from the system automatically. If some or all of this information is
Dave Love <fx@gnu.org>
parents:
diff changeset
1401 missing, Emacs fills in the gaps with the rules currently used in
Dave Love <fx@gnu.org>
parents:
diff changeset
1402 Cambridge, Massachusetts. If the resulting rules are not what you want,
Dave Love <fx@gnu.org>
parents:
diff changeset
1403 you can tell Emacs the rules to use by setting certain variables:
Dave Love <fx@gnu.org>
parents:
diff changeset
1404 @code{calendar-daylight-savings-starts} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1405 @code{calendar-daylight-savings-ends}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1406
Dave Love <fx@gnu.org>
parents:
diff changeset
1407 These values should be Lisp expressions that refer to the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1408 @code{year}, and evaluate to the Gregorian date on which daylight
Dave Love <fx@gnu.org>
parents:
diff changeset
1409 savings time starts or (respectively) ends, in the form of a list
Dave Love <fx@gnu.org>
parents:
diff changeset
1410 @code{(@var{month} @var{day} @var{year})}. The values should be
Dave Love <fx@gnu.org>
parents:
diff changeset
1411 @code{nil} if your area does not use daylight savings time.
Dave Love <fx@gnu.org>
parents:
diff changeset
1412
Dave Love <fx@gnu.org>
parents:
diff changeset
1413 Emacs uses these expressions to determine the starting date of
Dave Love <fx@gnu.org>
parents:
diff changeset
1414 daylight savings time for the holiday list and for correcting times of
Dave Love <fx@gnu.org>
parents:
diff changeset
1415 day in the solar and lunar calculations.
Dave Love <fx@gnu.org>
parents:
diff changeset
1416
Dave Love <fx@gnu.org>
parents:
diff changeset
1417 The values for Cambridge, Massachusetts are as follows:
Dave Love <fx@gnu.org>
parents:
diff changeset
1418
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 (calendar-nth-named-day 1 0 4 year)
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 (calendar-nth-named-day -1 0 10 year)
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1423
Dave Love <fx@gnu.org>
parents:
diff changeset
1424 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 That is, the first 0th day (Sunday) of the fourth month (April) in
Dave Love <fx@gnu.org>
parents:
diff changeset
1426 the year specified by @code{year}, and the last Sunday of the tenth month
Dave Love <fx@gnu.org>
parents:
diff changeset
1427 (October) of that year. If daylight savings time were
Dave Love <fx@gnu.org>
parents:
diff changeset
1428 changed to start on October 1, you would set
Dave Love <fx@gnu.org>
parents:
diff changeset
1429 @code{calendar-daylight-savings-starts} to this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1430
Dave Love <fx@gnu.org>
parents:
diff changeset
1431 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1432 (list 10 1 year)
Dave Love <fx@gnu.org>
parents:
diff changeset
1433 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1434
Dave Love <fx@gnu.org>
parents:
diff changeset
1435 If there is no daylight savings time at your location, or if you want
Dave Love <fx@gnu.org>
parents:
diff changeset
1436 all times in standard time, set @code{calendar-daylight-savings-starts}
Dave Love <fx@gnu.org>
parents:
diff changeset
1437 and @code{calendar-daylight-savings-ends} to @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1438
Dave Love <fx@gnu.org>
parents:
diff changeset
1439 @vindex calendar-daylight-time-offset
Dave Love <fx@gnu.org>
parents:
diff changeset
1440 The variable @code{calendar-daylight-time-offset} specifies the
Dave Love <fx@gnu.org>
parents:
diff changeset
1441 difference between daylight savings time and standard time, measured in
Dave Love <fx@gnu.org>
parents:
diff changeset
1442 minutes. The value for Cambridge, Massachusetts is 60.
Dave Love <fx@gnu.org>
parents:
diff changeset
1443
Dave Love <fx@gnu.org>
parents:
diff changeset
1444 @c @vindex calendar-daylight-savings-starts-time too long!
Dave Love <fx@gnu.org>
parents:
diff changeset
1445 @vindex calendar-daylight-savings-ends-time
Dave Love <fx@gnu.org>
parents:
diff changeset
1446 The two variables @code{calendar-daylight-savings-starts-time} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1447 @code{calendar-daylight-savings-ends-time} specify the number of minutes
Dave Love <fx@gnu.org>
parents:
diff changeset
1448 after midnight local time when the transition to and from daylight
Dave Love <fx@gnu.org>
parents:
diff changeset
1449 savings time should occur. For Cambridge, Massachusetts both variables'
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 values are 120.
30794
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1451
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1452 @node Time Intervals
36145
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1453 @section Summing Time Intervals
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1454 @cindex time intervals, summing
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1455 @cindex summing time intervals
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1456 @cindex timeclock
30794
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1457
36145
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1458 The timeclock feature adds up time intervals, so you can (for
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1459 instance) keep track of how much time you spend working.
30794
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1460
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1461 @findex timeclock-in
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1462 @findex timeclock-out
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1463 @findex timeclock-workday-remaining
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1464 @findex timeclock-when-to-leave
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1465 Use the @kbd{M-x timeclock-in} command when you start working on a
36145
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1466 project, and @kbd{M-x timeclock-out} command when you're done. Each
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1467 time you do this, it adds one time interval to the record of the project.
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1468
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1469 Once you've collected data from a number of time intervals, you can use
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1470 @kbd{M-x timeclock-workday-remaining} to see how much time is left to
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1471 work today (assuming a typical average of 8 hours a day), and @kbd{M-x
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1472 timeclock-when-to-leave} which will calculate when you're ``done.''
30794
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1473
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1474 @vindex timeclock-modeline-display
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1475 @findex timeclock-modeline-display
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1476 If you want Emacs to display the amount of time ``left'' of your
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1477 workday in the mode line, either customize the
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1478 @code{timeclock-modeline-display} variable and set its value to
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1479 @code{t}, or invoke the @kbd{M-x timeclock-modeline-display} command.
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1480
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1481 @vindex timeclock-ask-before-exiting
36145
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1482 Terminating the current Emacs session might or might not mean that
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1483 you have stopped working on the project. If you'd like Emacs to ask
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1484 you about this, set the value of the variable
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1485 @code{timeclock-ask-before-exiting} to @code{t} (via @kbd{M-x
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1486 customize}). By default, only an explicit @kbd{M-x timeclock-out}
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1487 tells Emacs that the current interval is over.
30794
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1488
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1489 @cindex @file{.timelog} file
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1490 @vindex timeclock-file
4711c3854433 (Time Intervals): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 25829
diff changeset
1491 @findex timeclock-reread-log
37709
e58e22c73805 Clarify `p' commands again.
Richard M. Stallman <rms@gnu.org>
parents: 37142
diff changeset
1492 The timeclock functions work by accumulating the data in a file
36145
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1493 called @file{.timelog} in your home directory. (On MS-DOS, this file
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1494 is called @file{_timelog}, since an initial period is not allowed in
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1495 file names on MS-DOS.) You can specify a different name for this file
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1496 by customizing the variable @code{timeclock-file}. If you edit the
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1497 timeclock file manually, or if you change the value of any of
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1498 timeclock's customizable variables, you should run the command
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1499 @kbd{M-x timeclock-reread-log} to update the data in Emacs from the
c70d510bdb54 Various clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 30794
diff changeset
1500 file.