aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2005-03-26 19:51:24 +0000
committerGlenn Morris2005-03-26 19:51:24 +0000
commit8913f91bc8aaf1ece35aa5b8a3244de3810ac5cd (patch)
treec4d7d71e399e216fe87f405ed1c79862dac9f088
parent0bd1a9c8d06eac99c283c029e2025fc7dc93d2d4 (diff)
downloademacs-8913f91bc8aaf1ece35aa5b8a3244de3810ac5cd.tar.gz
emacs-8913f91bc8aaf1ece35aa5b8a3244de3810ac5cd.zip
Update and reformat copyright.
(Calendar/Diary): Menu now only on Mouse-3, not C-Mouse-3. (Holidays): Move view-calendar-holidays-initially, mark-holidays-in-calendar here from emacs-xtra. (Diary): Refer to `diary-file' rather than ~/diary. (Diary Commands): Rename node to "Displaying the Diary". (Displaying the Diary): Move view-diary-entries-initially, mark-diary-entries-in-calendar here from emacs-xtra. (Appointments): Move appt-display-mode-line, appt-display-duration, appt-disp-window-function, appt-delete-window-function here from emacs-xtra.
-rw-r--r--man/calendar.texi92
1 files changed, 62 insertions, 30 deletions
diff --git a/man/calendar.texi b/man/calendar.texi
index 213c242bb9a..55ad177a85d 100644
--- a/man/calendar.texi
+++ b/man/calendar.texi
@@ -1,5 +1,6 @@
1@c This is part of the Emacs manual. 1@c This is part of the Emacs manual.
2@c Copyright (C) 1985,86,87,93,94,95,1997,2000,2001 Free Software Foundation, Inc. 2@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2000, 2001,
3@c 2005 Free Software Foundation, Inc.
3@c See file emacs.texi for copying conditions. 4@c See file emacs.texi for copying conditions.
4@node Calendar/Diary, Gnus, Dired, Top 5@node Calendar/Diary, Gnus, Dired, Top
5@chapter The Calendar and the Diary 6@chapter The Calendar and the Diary
@@ -19,11 +20,13 @@ calendar. The calendar uses its own buffer, whose major mode is
19Calendar mode. 20Calendar mode.
20 21
21 @kbd{Mouse-2} in the calendar brings up a menu of operations on a 22 @kbd{Mouse-2} in the calendar brings up a menu of operations on a
22particular date; @kbd{C-Mouse-3} brings up a menu of commonly used 23particular date; @kbd{Mouse-3} brings up a menu of commonly used
23calendar features that are independent of any particular date. To exit 24calendar features that are independent of any particular date. To exit
24the calendar, type @kbd{q}. @xref{Advanced Calendar/Diary Usage, 25the calendar, type @kbd{q}.
25Customizing the Calendar and Diary,, emacs-xtra, Specialized Emacs 26
26Features}, for customization information about the calendar and diary. 27The basic features of the Calendar/Diary are described here.
28@xref{Advanced Calendar/Diary Usage,,, emacs-xtra, Specialized Emacs
29Features}, for information about more specialized features.
27 30
28@menu 31@menu
29* Calendar Motion:: Moving through the calendar; selecting a date. 32* Calendar Motion:: Moving through the calendar; selecting a date.
@@ -423,24 +426,32 @@ List holidays in another window for a specified range of years.
423 426
424@kindex h @r{(Calendar mode)} 427@kindex h @r{(Calendar mode)}
425@findex calendar-cursor-holidays 428@findex calendar-cursor-holidays
429@vindex view-calendar-holidays-initially
426 To see if any holidays fall on a given date, position point on that 430 To see if any holidays fall on a given date, position point on that
427date in the calendar window and use the @kbd{h} command. Alternatively, 431date in the calendar window and use the @kbd{h} command. Alternatively,
428click on that date with @kbd{Mouse-2} and then choose @kbd{Holidays} 432click on that date with @kbd{Mouse-2} and then choose @kbd{Holidays}
429from the menu that appears. Either way, this displays the holidays for 433from the menu that appears. Either way, this displays the holidays for
430that date, in the echo area if they fit there, otherwise in a separate 434that date, in the echo area if they fit there, otherwise in a separate
431window. 435window. If the variable @code{view-calendar-holidays-initially} is
436non-@code{nil}, holidays are displayed when the calendar is created.
432 437
433@kindex x @r{(Calendar mode)} 438@kindex x @r{(Calendar mode)}
434@findex mark-calendar-holidays 439@findex mark-calendar-holidays
435@kindex u @r{(Calendar mode)} 440@kindex u @r{(Calendar mode)}
436@findex calendar-unmark 441@findex calendar-unmark
442@vindex mark-holidays-in-calendar
437 To view the distribution of holidays for all the dates shown in the 443 To view the distribution of holidays for all the dates shown in the
438calendar, use the @kbd{x} command. This displays the dates that are 444calendar, use the @kbd{x} command. This displays the dates that are
439holidays in a different face (or places a @samp{*} after these dates, if 445holidays in a different face (or places a @samp{*} after these dates, if
440display with multiple faces is not available). The command applies both 446display with multiple faces is not available). @xref{Calendar
441to the currently visible months and to other months that subsequently 447Customizing,, calendar-holiday-marker, emacs-xtra, Specialized Emacs
442become visible by scrolling. To turn marking off and erase the current 448Features}. The command applies both to the currently visible months and
443marks, type @kbd{u}, which also erases any diary marks (@pxref{Diary}). 449to other months that subsequently become visible by scrolling. To turn
450marking off and erase the current marks, type @kbd{u}, which also erases
451any diary marks (@pxref{Diary}). If the variable
452@code{mark-holidays-in-calendar} is non-@code{nil}, holidays are marked
453in the calendar when it is created (or recomputed).
454
444 455
445@kindex a @r{(Calendar mode)} 456@kindex a @r{(Calendar mode)}
446@findex list-calendar-holidays 457@findex list-calendar-holidays
@@ -924,9 +935,9 @@ their dates. Then Emacs can automatically pick out and display the
924events for today, for the immediate future, or for any specified 935events for today, for the immediate future, or for any specified
925date. 936date.
926 937
927 By default, Emacs uses @file{~/diary} as the diary file. This is the 938 The name of the diary file is specified by the variable
928same file that the @code{calendar} utility uses. A sample 939@code{diary-file}; @file{~/diary} is the default. A sample diary file
929@file{~/diary} file is: 940is:
930 941
931@example 942@example
93212/22/1988 Twentieth wedding anniversary!! 94312/22/1988 Twentieth wedding anniversary!!
@@ -951,18 +962,18 @@ provides a number of commands to let you view, add, and change diary
951entries. 962entries.
952 963
953@menu 964@menu
954* Diary Commands:: Viewing diary entries and associated calendar dates. 965* Displaying the Diary:: Viewing diary entries and associated calendar dates.
955* Format of Diary File:: Entering events in your diary. 966* Format of Diary File:: Entering events in your diary.
956* Date Formats:: Various ways you can specify dates. 967* Date Formats:: Various ways you can specify dates.
957* Adding to Diary:: Commands to create diary entries. 968* Adding to Diary:: Commands to create diary entries.
958* Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. 969* Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc.
959@end menu 970@end menu
960 971
961@node Diary Commands 972@node Displaying the Diary
962@subsection Commands Displaying Diary Entries 973@subsection Displaying the Diary
963 974
964 Once you have created a @file{~/diary} file, you can use the calendar 975 Once you have created a diary file, you can use the calendar to view
965to view it. You can also view today's events outside of Calendar mode. 976it. You can also view today's events outside of Calendar mode.
966 977
967@table @kbd 978@table @kbd
968@item d 979@item d
@@ -987,13 +998,16 @@ Mail yourself email reminders about upcoming diary entries.
987 998
988@kindex d @r{(Calendar mode)} 999@kindex d @r{(Calendar mode)}
989@findex view-diary-entries 1000@findex view-diary-entries
1001@vindex view-diary-entries-initially
990 Displaying the diary entries with @kbd{d} shows in a separate window 1002 Displaying the diary entries with @kbd{d} shows in a separate window
991the diary entries for the selected date in the calendar. The mode line 1003the diary entries for the selected date in the calendar. The mode line
992of the new window shows the date of the diary entries and any holidays 1004of the new window shows the date of the diary entries and any holidays
993that fall on that date. If you specify a numeric argument with @kbd{d}, 1005that fall on that date. If you specify a numeric argument with @kbd{d},
994it shows all the diary entries for that many successive days. Thus, 1006it shows all the diary entries for that many successive days. Thus,
995@kbd{2 d} displays all the entries for the selected date and for the 1007@kbd{2 d} displays all the entries for the selected date and for the
996following day. 1008following day. If the variable @code{view-diary-entries-initially} is
1009non-@code{nil}, the diary entries for the current date are displayed
1010when the calendar is created (provided the current date is visible).
997 1011
998 Another way to display the diary entries for a date is to click 1012 Another way to display the diary entries for a date is to click
999@kbd{Mouse-2} on the date, and then choose @kbd{Diary entries} from 1013@kbd{Mouse-2} on the date, and then choose @kbd{Diary entries} from
@@ -1001,14 +1015,18 @@ the menu that appears.
1001 1015
1002@kindex m @r{(Calendar mode)} 1016@kindex m @r{(Calendar mode)}
1003@findex mark-diary-entries 1017@findex mark-diary-entries
1018@vindex mark-diary-entries-in-calendar
1004 To get a broader view of which days are mentioned in the diary, use 1019 To get a broader view of which days are mentioned in the diary, use
1005the @kbd{m} command. This displays the dates that have diary entries 1020the @kbd{m} command. This displays the dates that have diary entries in
1006in a different face (or places a @samp{+} after these dates, if 1021a different face (or places a @samp{+} after these dates, if display
1007display with multiple faces is not available). The command applies both 1022with multiple faces is not available). @xref{Calendar Customizing,,
1008to the currently visible months and to other months that subsequently 1023diary-entry-marker, emacs-xtra, Specialized Emacs Features}. The
1009become visible by scrolling. To turn marking off and erase the current 1024command applies both to the currently visible months and to other months
1010marks, type @kbd{u}, which also turns off holiday marks 1025that subsequently become visible by scrolling. To turn marking off and
1011(@pxref{Holidays}). 1026erase the current marks, type @kbd{u}, which also turns off holiday
1027marks (@pxref{Holidays}). If the variable
1028@code{mark-diary-entries-in-calendar} is non-@code{nil}, diary dates are
1029marked in the calendar when it is created (or recomputed).
1012 1030
1013@kindex s @r{(Calendar mode)} 1031@kindex s @r{(Calendar mode)}
1014@findex show-all-diary-entries 1032@findex show-all-diary-entries
@@ -1345,16 +1363,30 @@ Emacs Features}.
1345 1363
1346@vindex appt-display-format 1364@vindex appt-display-format
1347@vindex appt-audible 1365@vindex appt-audible
1366@vindex appt-display-mode-line
1348 If you have a diary entry for an appointment, and that diary entry 1367 If you have a diary entry for an appointment, and that diary entry
1349begins with a recognizable time of day, Emacs can warn you several 1368begins with a recognizable time of day, Emacs can warn you several
1350minutes beforehand that that appointment is pending. Emacs alerts you 1369minutes beforehand that that appointment is pending. Emacs alerts you
1351to the appointment by displaying a message in your chosen format, as 1370to the appointment by displaying a message in your chosen format, as
1352specified by the variable @code{appt-display-format}. If the value 1371specified by the variable @code{appt-display-format}. If the value of
1353of @code{appt-audible} is non-@code{nil}, an audible reminder is also given. 1372@code{appt-audible} is non-@code{nil}, an audible reminder is also
1373given. In addition, if @code{appt-display-mode-line} is non-@code{nil},
1374Emacs displays the number of minutes to the appointment on the mode
1375line.
1376
1377@vindex appt-display-duration
1378@vindex appt-disp-window-function
1379@vindex appt-delete-window-function
1380 If @code{appt-display-format} has the value @code{window}, then the
1381variable @code{appt-display-duration} controls how long the reminder
1382window is visible for; and the variables
1383@code{appt-disp-window-function} and @code{appt-delete-window-function}
1384give the names of functions used to create and destroy the window,
1385respectively.
1354 1386
1355@findex appt-activate 1387@findex appt-activate
1356 To enable appointment notification, call the function 1388 To enable appointment notification, call the function
1357@code{appt-activate} with a positive argument. This sets up an 1389@code{appt-activate} with a positive argument. This sets up an
1358appointment list for today from the diary file, giving all diary entries 1390appointment list for today from the diary file, giving all diary entries
1359found with recognizable times of day, and reminds you just before each 1391found with recognizable times of day, and reminds you just before each
1360of them. Calling @code{appt-activate} with a negative argument disables 1392of them. Calling @code{appt-activate} with a negative argument disables
@@ -1371,7 +1403,7 @@ Monday
1371@vindex appt-message-warning-time 1403@vindex appt-message-warning-time
1372@noindent 1404@noindent
1373Then on Mondays, you will be reminded at around 9:20am about your coffee 1405Then on Mondays, you will be reminded at around 9:20am about your coffee
1374break and at around 11:50am about lunch. How many minutes in advance you 1406break and at around 11:50am about lunch. How many minutes in advance you
1375are first warned is determined by the value of 1407are first warned is determined by the value of
1376@code{appt-message-warning-time}. 1408@code{appt-message-warning-time}.
1377 1409