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