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