aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2006-03-12 13:10:02 +0000
committerRichard M. Stallman2006-03-12 13:10:02 +0000
commitc49f972f9707d2a7103f541d2c975b034f528d13 (patch)
treee98d789b933286fbb4b8aa55c74af649dd6b919a
parent204b78de1b66429250e18785a65392b5027ef103 (diff)
downloademacs-c49f972f9707d2a7103f541d2c975b034f528d13.tar.gz
emacs-c49f972f9707d2a7103f541d2c975b034f528d13.zip
Various cleanups.
-rw-r--r--man/calendar.texi111
1 files changed, 56 insertions, 55 deletions
diff --git a/man/calendar.texi b/man/calendar.texi
index 988a509ca02..23aeb191e86 100644
--- a/man/calendar.texi
+++ b/man/calendar.texi
@@ -24,7 +24,7 @@ particular date; @kbd{Mouse-3} brings up a menu of commonly used
24calendar features that are independent of any particular date. To exit 24calendar features that are independent of any particular date. To exit
25the calendar, type @kbd{q}. 25the calendar, type @kbd{q}.
26 26
27The basic features of the Calendar/Diary are described here. 27 This chapter describes the basic calendar features.
28@inforef{Advanced Calendar/Diary Usage,, emacs-xtra}, for information 28@inforef{Advanced Calendar/Diary Usage,, emacs-xtra}, for information
29about more specialized features. 29about more specialized features.
30 30
@@ -49,13 +49,13 @@ about more specialized features.
49@section Movement in the Calendar 49@section Movement in the Calendar
50 50
51@cindex moving inside the calendar 51@cindex moving inside the calendar
52 Calendar mode lets you move through the calendar in logical units of 52 Calendar mode provides commands to move through the calendar in
53time such as days, weeks, months, and years. If you move outside the 53logical units of time such as days, weeks, months, and years. If you
54three months originally displayed, the calendar display ``scrolls'' 54move outside the three months originally displayed, the calendar
55automatically through time to make the selected date visible. Moving to 55display ``scrolls'' automatically through time to make the selected
56a date lets you view its holidays or diary entries, or convert it to other 56date visible. Moving to a date lets you view its holidays or diary
57calendars; moving longer time periods is also useful simply to scroll the 57entries, or convert it to other calendars; moving by long time periods
58calendar. 58is also useful simply to scroll the calendar.
59 59
60@menu 60@menu
61* Calendar Unit Motion:: Moving by days, weeks, months, and years. 61* Calendar Unit Motion:: Moving by days, weeks, months, and years.
@@ -117,16 +117,16 @@ moves to the same day in the previous week.
117@findex calendar-forward-year 117@findex calendar-forward-year
118 The commands for motion by months and years work like those for 118 The commands for motion by months and years work like those for
119weeks, but move a larger distance. The month commands @kbd{M-@}} and 119weeks, but move a larger distance. The month commands @kbd{M-@}} and
120@kbd{M-@{} move forward or backward by an entire month's time. The 120@kbd{M-@{} move forward or backward by an entire month. The year
121year commands @kbd{C-x ]} and @w{@kbd{C-x [}} move forward or backward a 121commands @kbd{C-x ]} and @w{@kbd{C-x [}} move forward or backward a
122whole year. 122whole year.
123 123
124 The easiest way to remember these commands is to consider months and 124 The easiest way to remember these commands is to consider months and
125years analogous to paragraphs and pages of text, respectively. But the 125years analogous to paragraphs and pages of text, respectively. But
126commands themselves are not quite analogous. The ordinary Emacs paragraph 126the commands themselves are not quite analogous. The ordinary Emacs
127commands move to the beginning or end of a paragraph, whereas these month 127paragraph commands move to the beginning or end of a paragraph,
128and year commands move by an entire month or an entire year, which usually 128whereas these month and year commands move by an entire month or an
129involves skipping across the end of a month or year. 129entire year, keeping the same date within the month or year.
130 130
131 All these commands accept a numeric argument as a repeat count. 131 All these commands accept a numeric argument as a repeat count.
132For convenience, the digit keys and the minus sign specify numeric 132For convenience, the digit keys and the minus sign specify numeric
@@ -313,8 +313,8 @@ Exit from calendar (@code{exit-calendar}).
313 To display the number of days elapsed since the start of the year, or 313 To display the number of days elapsed since the start of the year, or
314the number of days remaining in the year, type the @kbd{p d} command 314the number of days remaining in the year, type the @kbd{p d} command
315(@code{calendar-print-day-of-year}). This displays both of those 315(@code{calendar-print-day-of-year}). This displays both of those
316numbers in the echo area. The number of days elapsed includes the 316numbers in the echo area. The count of days elapsed includes the
317selected date. The number of days remaining does not include that 317selected date. The count of days remaining does not include that
318date. 318date.
319 319
320@kindex C-c C-l @r{(Calendar mode)} 320@kindex C-c C-l @r{(Calendar mode)}
@@ -432,8 +432,7 @@ date in the calendar window and use the @kbd{h} command. Alternatively,
432click 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}
433from the menu that appears. Either way, this displays the holidays for 433from the menu that appears. Either way, this displays the holidays for
434that 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
435window. If the variable @code{view-calendar-holidays-initially} is 435window.
436non-@code{nil}, creating the calendar displays holidays in this way.
437 436
438@kindex x @r{(Calendar mode)} 437@kindex x @r{(Calendar mode)}
439@findex mark-calendar-holidays 438@findex mark-calendar-holidays
@@ -462,9 +461,11 @@ calendar window to scroll that list up and down, respectively.
462@findex holidays 461@findex holidays
463 The command @kbd{M-x holidays} displays the list of holidays for the 462 The command @kbd{M-x holidays} displays the list of holidays for the
464current month and the preceding and succeeding months; this works even 463current month and the preceding and succeeding months; this works even
465if you don't have a calendar window. If you want the list of holidays 464if you don't have a calendar window. If the variable
466centered around a different month, use @kbd{C-u M-x holidays}, which 465@code{view-calendar-holidays-initially} is non-@code{nil}, creating
467prompts for the month and year. 466the calendar displays holidays in this way. If you want the list of
467holidays centered around a different month, use @kbd{C-u M-x
468holidays}, which prompts for the month and year.
468 469
469 The holidays known to Emacs include United States holidays and the 470 The holidays known to Emacs include United States holidays and the
470major Christian, Jewish, and Islamic holidays; also the solstices and 471major Christian, Jewish, and Islamic holidays; also the solstices and
@@ -1017,7 +1018,7 @@ following day.
1017@kbd{Mouse-2} on the date, and then choose @kbd{Diary entries} from 1018@kbd{Mouse-2} on the date, and then choose @kbd{Diary entries} from
1018the menu that appears. If the variable 1019the menu that appears. If the variable
1019@code{view-diary-entries-initially} is non-@code{nil}, creating the 1020@code{view-diary-entries-initially} is non-@code{nil}, creating the
1020calendar also lists diary entries for the current date (provided the 1021calendar lists the diary entries for the current date (provided the
1021current date is visible). 1022current date is visible).
1022 1023
1023@kindex m @r{(Calendar mode)} 1024@kindex m @r{(Calendar mode)}
@@ -1371,10 +1372,10 @@ begins with a recognizable time of day, Emacs can warn you several
1371minutes beforehand that that appointment is pending. Emacs alerts you 1372minutes beforehand that that appointment is pending. Emacs alerts you
1372to the appointment by displaying a message in your chosen format, as 1373to the appointment by displaying a message in your chosen format, as
1373specified by the variable @code{appt-display-format}. If the value of 1374specified by the variable @code{appt-display-format}. If the value of
1374@code{appt-audible} is non-@code{nil}, an audible reminder is also 1375@code{appt-audible} is non-@code{nil}, the warning includes an audible
1375given. In addition, if @code{appt-display-mode-line} is non-@code{nil}, 1376reminder. In addition, if @code{appt-display-mode-line} is
1376Emacs displays the number of minutes to the appointment on the mode 1377non-@code{nil}, Emacs displays the number of minutes to the
1377line. 1378appointment on the mode line.
1378 1379
1379@vindex appt-display-duration 1380@vindex appt-display-duration
1380@vindex appt-disp-window-function 1381@vindex appt-disp-window-function
@@ -1387,12 +1388,12 @@ give the names of functions used to create and destroy the window,
1387respectively. 1388respectively.
1388 1389
1389@findex appt-activate 1390@findex appt-activate
1390 To enable appointment notification, call the function 1391 To enable appointment notification, use the command @kbd{M-x
1391@code{appt-activate} with a positive argument. This sets up an 1392appt-activate}. With a positive argument, it enables notification;
1392appointment list for today from the diary file, giving all diary entries 1393with a negative argument, it disables notification; with no argument,
1393found with recognizable times of day, and reminds you just before each 1394it toggles. Enabling notification also sets up an appointment list
1394of them. Calling @code{appt-activate} with a negative argument disables 1395for today from the diary file, giving all diary entries found with
1395the appointment package. With no argument, it toggles. 1396recognizable times of day, and reminds you just before each of them.
1396 1397
1397 For example, suppose the diary file contains these lines: 1398 For example, suppose the diary file contains these lines:
1398 1399
@@ -1404,10 +1405,10 @@ Monday
1404 1405
1405@vindex appt-message-warning-time 1406@vindex appt-message-warning-time
1406@noindent 1407@noindent
1407Then on Mondays, you will be reminded at around 9:20am about your coffee 1408Then on Mondays, you will be reminded at around 9:20am about your
1408break and at around 11:50am about lunch. How many minutes in advance you 1409coffee break and at around 11:50am about lunch. The variable
1409are first warned is determined by the value of 1410@code{appt-message-warning-time} specifies how many minutes in advance
1410@code{appt-message-warning-time}. 1411to warn you; its default value is 12 (12 minutes).
1411 1412
1412 You can write times in am/pm style (with @samp{12:00am} standing 1413 You can write times in am/pm style (with @samp{12:00am} standing
1413for midnight and @samp{12:00pm} standing for noon), or 24-hour 1414for midnight and @samp{12:00pm} standing for noon), or 24-hour
@@ -1416,12 +1417,12 @@ can have a mixture of the two styles. Times must be at the beginning
1416of lines if they are to be recognized. 1417of lines if they are to be recognized.
1417 1418
1418@vindex appt-display-diary 1419@vindex appt-display-diary
1419 Emacs updates the appointments list from the diary file automatically 1420 Emacs updates the appointments list from the diary file
1420just after midnight. An update can be forced at any time by 1421automatically just after midnight. You can force an update at any
1421re-activating the appointment package. Both these actions also display 1422time by re-enabling appointment notification. Both these actions also
1422the day's diary buffer, unless you set @code{appt-display-diary} to 1423display the day's diary buffer, unless you set
1423@code{nil}. The appointments list is also updated whenever the 1424@code{appt-display-diary} to @code{nil}. The appointments list is
1424diary file is saved. 1425also updated whenever the diary file is saved.
1425 1426
1426@findex appt-add 1427@findex appt-add
1427@findex appt-delete 1428@findex appt-delete
@@ -1450,11 +1451,11 @@ diary file and iCalendar files, which are defined in ``RFC
14502445---Internet Calendaring and Scheduling Core Object Specification 14512445---Internet Calendaring and Scheduling Core Object Specification
1451(iCalendar)'' (as well as the earlier vCalendar format). 1452(iCalendar)'' (as well as the earlier vCalendar format).
1452 1453
1453 Importing works for ``ordinary'' (i.e. non-recurring) events, but (at 1454 Importing works for ``ordinary'' (i.e. non-recurring) events, but
1454present) may not work correctly (if at all) for recurring events. 1455(at present) may not work correctly (if at all) for recurring events.
1455Exporting of diary files into iCalendar files should work correctly for 1456Exporting of diary files into iCalendar files should work correctly
1456most diary entries. Please note that @file{icalendar.el} is work in 1457for most diary entries. This feature is a work in progress, so the
1457progress, so usage may evolve in future. 1458commands may evolve in future.
1458 1459
1459@findex icalendar-import-buffer 1460@findex icalendar-import-buffer
1460 The command @code{icalendar-import-buffer} extracts 1461 The command @code{icalendar-import-buffer} extracts
@@ -1476,7 +1477,7 @@ and adds the results to an Emacs diary file. For example:
1476 1477
1477@noindent 1478@noindent
1478You can use an @code{#include} directive to add the import file contents 1479You can use an @code{#include} directive to add the import file contents
1479to the main diary file, if these are distinct. @inforef{Fancy Diary 1480to the main diary file, if these are different files. @inforef{Fancy Diary
1480Display,, emacs-xtra}. 1481Display,, emacs-xtra}.
1481 1482
1482@findex icalendar-export-file, icalendar-export-region 1483@findex icalendar-export-file, icalendar-export-region
@@ -1485,7 +1486,6 @@ Emacs diary file to iCalendar format. To export only a part of a diary
1485file, mark the relevant area, and call @code{icalendar-export-region}. 1486file, mark the relevant area, and call @code{icalendar-export-region}.
1486In both cases the result is appended to the target file. 1487In both cases the result is appended to the target file.
1487 1488
1488
1489@node Daylight Savings 1489@node Daylight Savings
1490@section Daylight Savings Time 1490@section Daylight Savings Time
1491@cindex daylight savings time 1491@cindex daylight savings time
@@ -1560,7 +1560,8 @@ values are 120.
1560@cindex timeclock 1560@cindex timeclock
1561 1561
1562 The timeclock feature adds up time intervals, so you can (for 1562 The timeclock feature adds up time intervals, so you can (for
1563instance) keep track of how much time you spend working. 1563instance) keep track of how much time you spend working on particular
1564projects.
1564 1565
1565@findex timeclock-in 1566@findex timeclock-in
1566@findex timeclock-out 1567@findex timeclock-out
@@ -1586,11 +1587,11 @@ workday in the mode line, either customize the
1586@code{t}, or invoke the @kbd{M-x timeclock-modeline-display} command. 1587@code{t}, or invoke the @kbd{M-x timeclock-modeline-display} command.
1587 1588
1588@vindex timeclock-ask-before-exiting 1589@vindex timeclock-ask-before-exiting
1589 Terminating the current Emacs session might or might not mean that you 1590 Terminating the current Emacs session might or might not mean that
1590have stopped working on the project and, by default, Emacs queries this. 1591you have stopped working on the project and, by default, Emacs asks
1591You can, however, set the value of the variable 1592you. You can, however, set the value of the variable
1592@code{timeclock-ask-before-exiting} to @code{nil} (via @kbd{M-x 1593@code{timeclock-ask-before-exiting} to @code{nil} (via @kbd{M-x
1593customize}) to avoid this behavior; then, only an explicit @kbd{M-x 1594customize}) to avoid the question; then, only an explicit @kbd{M-x
1594timeclock-out} or @kbd{M-x timeclock-change} will tell Emacs that the 1595timeclock-out} or @kbd{M-x timeclock-change} will tell Emacs that the
1595current interval is over. 1596current interval is over.
1596 1597