Mercurial > hg > xemacs-beta
diff man/xemacs/calendar.texi @ 298:70ad99077275 r21-0b47
Import from CVS: tag r21-0b47
author | cvs |
---|---|
date | Mon, 13 Aug 2007 10:39:40 +0200 |
parents | ac2d302a0011 |
children | 512e409c26a2 |
line wrap: on
line diff
--- a/man/xemacs/calendar.texi Mon Aug 13 10:38:47 2007 +0200 +++ b/man/xemacs/calendar.texi Mon Aug 13 10:39:40 2007 +0200 @@ -3,24 +3,27 @@ @cindex calendar @findex calendar - Emacs provides the functions of a desk calendar, with a diary of past -or planned events. Display the calendar by typing @kbd{M-x calendar}. -This command creates a window containing a three-month calendar centered -on the current month, with point on the current date. Or, provide a -prefix argument by typing @kbd{C-u M-x calendar}; then you are prompted -for the month and year to be the center of the three-month calendar. In -either case, you are now in Calendar mode. + Emacs provides the functions of a desk calendar, with a diary of +planned or past events. To enter the calendar, type @kbd{M-x calendar}; +this displays a three-month calendar centered on the current month, with +point on the current date. With a numeric argument, as in @kbd{C-u M-x +calendar}, it prompts you for the month and year to be the center of the +three-month calendar. The calendar uses its own buffer, whose major +mode is Calendar mode. - Calendar mode makes it easy to look at the holidays or diary entries -associated with various dates, and to change the diary entries. You can move -freely between the Calendar window and other windows. To exit the calendar, -type @kbd{q}. - + @kbd{Button2} in the calendar brings up a menu of operations on a +particular date; @kbd{Buttons3} brings up a menu of commonly used +calendar features that are independent of any particular date. To exit +the calendar, type @kbd{q}. @xref{Calendar, Customizing the Calendar +and Diary,, elisp, The Emacs Lisp Reference Manual}, for customization +information about the calendar and diary. + @menu * Calendar Motion:: Moving through the calendar; selecting a date. * Scroll Calendar:: Bringing earlier or later months onto the screen. * Mark and Region:: Remembering dates, the mark ring. -* General Calendar:: Conveniences for moving about. +* General Calendar:: Exiting or recomputing the calendar. +* LaTeX Calendar:: Print a calendar using LaTeX. * Holidays:: Displaying dates of holidays. * Sunrise/Sunset:: Displaying local times of sunrise and sunset. * Lunar Phases:: Displaying phases of the moon. @@ -32,16 +35,20 @@ @node Calendar Motion, Scroll Calendar, Calendar/Diary, Calendar/Diary @subsection Movement in the Calendar - Calendar mode lets you move in logical units of time such as days, -weeks, months, and years. Sometimes you need to move to a specific date -in order to enter commands affecting its display or the associated diary -entries. If you move outside the three months originally displayed, the -calendar display scrolls automatically through time. +@cindex moving inside the calendar + Calendar mode lets you move through the calendar in logical units of +time such as days, weeks, months, and years. If you move outside the +three months originally displayed, the calendar display ``scrolls'' +automatically through time to make the selected date visible. Moving to +a date lets you view its holidays or diary entries, or convert it to other +calendars; moving longer time periods is also useful simply to scroll the +calendar. @menu * Calendar Unit Motion:: Moving by days, weeks, months, and years. * Move to Beginning or End:: Moving to start/end of weeks, months, and years. -* Specified Dates:: Moving to the current date or another specific date. +* Specified Dates:: Moving to the current date or another + specific date. @end menu @node Calendar Unit Motion, Move to Beginning or End, Calendar Motion, Calendar Motion @@ -67,16 +74,16 @@ @item C-x ] Move point one year forward (@code{calendar-forward-year}). @item C-x [ -Move point one year backward (@code{calendar-forward-year}). +Move point one year backward (@code{calendar-backward-year}). @end table -@kindex C-f (Calendar mode) +@kindex C-f @r{(Calendar mode)} @findex calendar-forward-day -@kindex C-b (Calendar mode) +@kindex C-b @r{(Calendar mode)} @findex calendar-backward-day -@kindex C-n (Calendar mode) +@kindex C-n @r{(Calendar mode)} @findex calendar-forward-week -@kindex C-p (Calendar mode) +@kindex C-p @r{(Calendar mode)} @findex calendar-backward-week The day and week commands are natural analogues of the usual Emacs commands for moving by characters and by lines. Just as @kbd{C-n} @@ -84,18 +91,21 @@ mode it moves to the same day in the following week. And @kbd{C-p} moves to the same day in the previous week. -@kindex M-@} (Calendar mode) + The arrow keys are equivalent to @kbd{C-f}, @kbd{C-b}, @kbd{C-n} and +@kbd{C-p}, just as they normally are in other modes. + +@kindex M-@} @r{(Calendar mode)} @findex calendar-forward-month -@kindex M-@{ (Calendar mode) +@kindex M-@{ @r{(Calendar mode)} @findex calendar-backward-month -@kindex C-x ] (Calendar mode) +@kindex C-x ] @r{(Calendar mode)} @findex calendar-forward-year -@kindex C-x [ (Calendar mode) +@kindex C-x [ @r{(Calendar mode)} @findex calendar-forward-year The commands for motion by months and years work like those for weeks, but move a larger distance. The month commands @kbd{M-@}} and @kbd{M-@{} move forward or backward by an entire month's time. The -year commands @kbd{C-x ]} and @kbd{C-x [} move forward or backward a +year commands @kbd{C-x ]} and @w{@kbd{C-x [}} move forward or backward a whole year. The easiest way to remember these commands is to consider months and @@ -105,41 +115,41 @@ and year commands move by an entire month or an entire year, which usually involves skipping across the end of a month or year. - Each of these commands accepts a numeric argument as a repeat count. For -convenience, the digit keys and the minus sign are bound in Calendar mode so -that it is unnecessary to type the @kbd{M-} prefix. For example, @kbd{100 -C-f} moves point 100 days forward from its present location. + All these commands accept a numeric argument as a repeat count. +For convenience, the digit keys and the minus sign specify numeric +arguments in Calendar mode even without the Meta modifier. For example, +@kbd{100 C-f} moves point 100 days forward from its present location. @node Move to Beginning or End, Specified Dates, Calendar Unit Motion, Calendar Motion @subsubsection Beginning or End of Week, Month or Year - A week (or month, or year) is not just a quantity of days; we think -of new weeks (months, years) as starting on particular days. So -Calendar mode provides commands to move to the beginning or end of the -week, month or year: - + A week (or month, or year) is not just a quantity of days; we think of +weeks (months, years) as starting on particular dates. So Calendar mode +provides commands to move to the beginning or end of a week, month or +year: + @table @kbd -@kindex C-a (Calendar mode) +@kindex C-a @r{(Calendar mode)} @findex calendar-beginning-of-week @item C-a -Move point to beginning of week (@code{calendar-beginning-of-week}). -@kindex C-e (Calendar mode) +Move point to start of week (@code{calendar-beginning-of-week}). +@kindex C-e @r{(Calendar mode)} @findex calendar-end-of-week @item C-e Move point to end of week (@code{calendar-end-of-week}). -@kindex M-a (Calendar mode) +@kindex M-a @r{(Calendar mode)} @findex calendar-beginning-of-month @item M-a -Move point to beginning of month (@code{calendar-beginning-of-month}). -@kindex M-e (Calendar mode) +Move point to start of month (@code{calendar-beginning-of-month}). +@kindex M-e @r{(Calendar mode)} @findex calendar-end-of-month @item M-e Move point to end of month (@code{calendar-end-of-month}). -@kindex M-< (Calendar mode) +@kindex M-< @r{(Calendar mode)} @findex calendar-beginning-of-year @item M-< -Move point to beginning of year (@code{calendar-beginning-of-year}). -@kindex M-> (Calendar mode) +Move point to start of year (@code{calendar-beginning-of-year}). +@kindex M-> @r{(Calendar mode)} @findex calendar-end-of-year @item M-> Move point to end of year (@code{calendar-end-of-year}). @@ -149,11 +159,17 @@ repeat count indicating how many weeks, months, or years to move backward or forward. +@vindex calendar-week-start-day +@cindex weeks, which day they start on +@cindex calendar, first day of week + By default, weeks begin on Sunday. To make them begin on Monday +instead, set the variable @code{calendar-week-start-day} to 1. + @node Specified Dates,,Move to Beginning or End, Calendar Motion @subsubsection Particular Dates - Calendar mode provides some commands for getting to a particular date -quickly. + Calendar mode provides commands for moving to a particular date +specified in various ways. @table @kbd @item g d @@ -161,29 +177,30 @@ @item o Center calendar around specified month (@code{calendar-other-month}). @item . -Move point to today's date (@code{calendar-current-month}). +Move point to today's date (@code{calendar-goto-today}). @end table -@kindex g d (Calendar mode) +@kindex g d @r{(Calendar mode)} @findex calendar-goto-date @kbd{g d} (@code{calendar-goto-date}) prompts for a year, a month, and a day -of the month, and then goes to that date. Because the calendar includes all +of the month, and then moves to that date. Because the calendar includes all dates from the beginning of the current era, you must type the year in its entirety; that is, type @samp{1990}, not @samp{90}. -@kindex o (Calendar mode) +@kindex o @r{(Calendar mode)} @findex calendar-other-month @kbd{o} (@code{calendar-other-month}) prompts for a month and year, then centers the three-month calendar around that month. -@kindex . (Calendar mode) -@findex calendar-current-month - You can return to the current date with @kbd{.} -(@code{calendar-current-month}). +@kindex . @r{(Calendar mode)} +@findex calendar-goto-today + You can return to today's date with @kbd{.} +(@code{calendar-goto-today}). @node Scroll Calendar, Mark and Region, Calendar Motion, Calendar/Diary @subsection Scrolling the Calendar through Time +@cindex scrolling in the calendar The calendar display scrolls automatically through time when you move out of the visible portion. You can also scroll it manually. Imagine that the calendar window contains a long strip of paper with the months on it. @@ -196,16 +213,18 @@ @item C-x > Scroll calendar one month backward (@code{scroll-calendar-right}). @item C-v +@itemx @key{NEXT} Scroll calendar three months forward (@code{scroll-calendar-left-three-months}). @item M-v +@itemx @key{PRIOR} Scroll calendar three months backward (@code{scroll-calendar-right-three-months}). @end table -@kindex C-x < (Calendar mode) +@kindex C-x < @r{(Calendar mode)} @findex scroll-calendar-left -@kindex C-x > (Calendar mode) +@kindex C-x > @r{(Calendar mode)} @findex scroll-calendar-right The most basic calendar scroll commands scroll by one month at a time. This means that there are two months of overlap between the @@ -214,20 +233,21 @@ display forward in time. @kbd{C-x >} scrolls the contents to the right, which moves backwards in time. -@kindex C-v (Calendar mode) +@kindex C-v @r{(Calendar mode)} @findex scroll-calendar-left-three-months -@kindex M-v (Calendar mode) +@kindex M-v @r{(Calendar mode)} @findex scroll-calendar-right-three-months The commands @kbd{C-v} and @kbd{M-v} scroll the calendar by an entire -``screenful''---three months---in analogy with the usual meaning of these -commands. @kbd{C-v} makes later dates visible and @kbd{M-v} makes earlier -dates visible. These commands also take a numeric argument as a repeat -count; in particular, since @kbd{C-u} (@code{universal-argument}) multiplies -the next command by four, typing @kbd{C-u C-v} scrolls the calendar forward by -a year and typing @kbd{C-u M-v} scrolls the calendar backward by a year. +``screenful''---three months---in analogy with the usual meaning of +these commands. @kbd{C-v} makes later dates visible and @kbd{M-v} makes +earlier dates visible. These commands take a numeric argument as a +repeat count; in particular, since @kbd{C-u} multiplies the next command +by four, typing @kbd{C-u C-v} scrolls the calendar forward by a year and +typing @kbd{C-u M-v} scrolls the calendar backward by a year. - Any of the special Calendar mode commands scrolls the calendar automatically -as necessary to ensure that the date you have moved to is visible. + The function keys @key{NEXT} and @key{PRIOR} are equivalent to +@kbd{C-v} and @kbd{M-v}, just as they are in other modes. + @node Mark and Region, General Calendar, Scroll Calendar, Calendar/Diary @subsection The Mark and the Region @@ -249,10 +269,10 @@ (@code{calendar-count-days-region}). @end table -@kindex C-@@ (Calendar mode) -@kindex C-SPC (Calendar mode) +@kindex C-@@ @r{(Calendar mode)} +@kindex C-SPC @r{(Calendar mode)} @findex calendar-set-mark -@kindex C-x C-x (Calendar mode) +@kindex C-x C-x @r{(Calendar mode)} @findex calendar-exchange-point-and-mark You set the mark in the calendar, as in any other buffer, by using @kbd{C-@@} or @kbd{C-SPC} (@code{calendar-set-mark}). You return to the marked date @@ -261,11 +281,12 @@ is scrolled as necessary, if the marked date was not visible on the screen. This does not change the extent of the region. -@kindex M-= (Calendar mode) +@kindex M-= @r{(Calendar mode)} @findex calendar-count-days-region To determine the number of days in the region, type @kbd{M-=} (@code{calendar-count-days-region}). The numbers of days printed is -@emph{inclusive}, that is, includes the days specified by mark and point. +@emph{inclusive}; that is, it includes the days specified by mark and +point. @cindex mark ring The main use of the mark in the calendar is to remember dates that you may @@ -278,7 +299,7 @@ the mark ring. So, repeated use of this command moves point through all the old marks on the ring, one by one. -@node General Calendar, Holidays, Mark and Region, Calendar/Diary +@node General Calendar, LaTeX Calendar, Mark and Region, Calendar/Diary @subsection Miscellaneous Calendar Commands @table @kbd @@ -286,15 +307,15 @@ Display day-in-year (@code{calendar-print-day-of-year}). @item ? Briefly describe calendar commands (@code{describe-calendar-mode}). +@item C-c C-l +Regenerate the calendar window (@code{redraw-calendar}). @item SPC Scroll the next window (@code{scroll-other-window}). -@item C-c C-l -Regenerate the calendar window (@code{redraw-calendar}). @item q Exit from calendar (@code{exit-calendar}). @end table -@kindex p d (Calendar mode) +@kindex p d @r{(Calendar mode)} @cindex day of year @findex calendar-print-day-of-year If you want to know how many days have elapsed since the start of @@ -302,38 +323,107 @@ command (@code{calendar-print-day-of-year}). This displays both of those numbers in the echo area. -@kindex ? (Calendar mode) +@kindex ? @r{(Calendar mode)} @findex describe-calendar-mode To display a brief description of the calendar commands, type @kbd{?} (@code{describe-calendar-mode}). For a fuller description, type @kbd{C-h m}. -@kindex SPC (Calendar mode) +@kindex SPC @r{(Calendar mode)} @findex scroll-other-window You can use @kbd{SPC} (@code{scroll-other-window}) to scroll the other window. This is handy when you display a list of holidays or diary entries in another window. -@kindex C-c C-l (Calendar mode) +@kindex C-c C-l @r{(Calendar mode)} @findex redraw-calendar - If the calendar window gets corrupted, type @kbd{C-c C-l} -(@code{redraw-calendar}) to redraw it. + If the calendar window text gets corrupted, type @kbd{C-c C-l} +(@code{redraw-calendar}) to redraw it. (This can only happen if you use +non-Calendar-mode editing commands.) -@kindex q (Calendar mode) +@kindex SPC @r{(Calendar mode)} + In Calendar mode, you can use @kbd{SPC} (@code{scroll-other-window}) +to scroll the other window. This is handy when you display a list of +holidays or diary entries in another window. + +@kindex q @r{(Calendar mode)} @findex exit-calendar To exit from the calendar, type @kbd{q} (@code{exit-calendar}). This -buries all buffers related to the calendar and returns the window display -to what it was when you entered the calendar. +buries all buffers related to the calendar, selecting other buffers. +(If a frame contains a dedicated calendar window, exiting from the +calendar iconifies that frame.) + +@node LaTeX Calendar, Holidays, General Calendar, Calendar/Diary +@section LaTeX Calendar +@cindex calendar and La@TeX{} + + The Calendar La@TeX{} commands produce a buffer of La@TeX{} code that +prints as a calendar. Depending on the command you use, the printed +calendar covers the day, week, month or year that point is in. -@node Holidays, Sunrise/Sunset, General Calendar, Calendar/Diary +@kindex t @r{(Calendar mode)} +@table @kbd +@item t m +Generate a one-month calendar (@code{cal-tex-cursor-month}). +@item t M +Generate a sideways-printing one-month calendar +(@code{cal-tex-cursor-month-landscape}). +@item t d +Generate a one-day calendar +(@code{cal-tex-cursor-day}). +@item t w 1 +Generate a one-page calendar for one week +(@code{cal-tex-cursor-week}). +@item t w 2 +Generate a two-page calendar for one week +(@code{cal-tex-cursor-week2}). +@item t w 3 +Generate an ISO-style calendar for one week +(@code{cal-tex-cursor-week-iso}). +@item t w 4 +Generate a calendar for one Monday-starting week +(@code{cal-tex-cursor-week-monday}). +@item t f w +Generate a Filofax-style two-weeks-at-a-glance calendar +(@code{cal-tex-cursor-filofax-2week}). +@item t f W +Generate a Filofax-style one-week-at-a-glance calendar +(@code{cal-tex-cursor-filofax-week}). +@item t y +Generate a calendar for one year +(@code{cal-tex-cursor-year}). +@item t Y +Generate a sideways-printing calendar for one year +(@code{cal-tex-cursor-landscape-year}). +@item t f y +Generate a Filofax-style calendar for one year +(@code{cal-tex-cursor-filofax-year}). +@end table + + Some of these commands print the calendar sideways (in ``landscape +mode''), so it can be wider than it is long. Some of them use Filofax +paper size (3.75in x 6.75in). All of these commands accept a prefix +argument which specifies how many days, weeks, months or years to print +(starting always with the selected one). + + If the variable @code{cal-tex-holidays} is non-@code{nil} (the +default), then the printed calendars show the holidays in +@code{calendar-holidays}. If the variable @code{cal-tex-diary} is +non-@code{nil} (the default is @code{nil}), diary entries are included +also (in weekly and monthly calendars only). + +@node Holidays, Sunrise/Sunset, LaTeX Calendar, Calendar/Diary @subsection Holidays @cindex holidays - The Emacs calendar knows about all major and many minor holidays. + The Emacs calendar knows about all major and many minor holidays, +and can display them. @table @kbd @item h -Display holidays for the date indicated by point +Display holidays for the selected date (@code{calendar-cursor-holidays}). +@item Button2 Holidays +Display any holidays for the date you click on. @item x Mark holidays in the calendar window (@code{mark-calendar-holidays}). @item u @@ -344,79 +434,104 @@ @item M-x holidays List all holidays for three months around today's date in another window. +@item M-x list-holidays +List holidays in another window for a specified range of years. @end table -@kindex h (Calendar mode) +@kindex h @r{(Calendar mode)} @findex calendar-cursor-holidays To see if any holidays fall on a given date, position point on that -date in the calendar window and use the @kbd{h} command. The holidays -are usually listed in the echo area, but if there are too many to fit in -one line, then they are displayed in a separate window. +date in the calendar window and use the @kbd{h} command. Alternatively, +click on that date with @kbd{Button2} and then choose @kbd{Holidays} +from the menu that appears. Either way, this displays the holidays for +that date, in the echo area if they fit there, otherwise in a separate +window. -@kindex x (Calendar mode) +@kindex x @r{(Calendar mode)} @findex mark-calendar-holidays -@kindex u (Calendar mode) +@kindex u @r{(Calendar mode)} @findex calendar-unmark - To find the distribution of holidays for a wider period, you can use the -@kbd{x} command. This places a @samp{*} next to every date on which a holiday -falls. The command applies both to the currently visible dates and to new -dates that become visible by scrolling. To turn marking off and erase the -current marks, type @kbd{u}, which also erases any diary marks (@pxref{Diary}). + To view the distribution of holidays for all the dates shown in the +calendar, use the @kbd{x} command. This displays the dates that are +holidays in a different face (or places a @samp{*} after these dates, if +display with multiple faces is not available). The command applies both +to the currently visible months and to other months that subsequently +become visible by scrolling. To turn marking off and erase the current +marks, type @kbd{u}, which also erases any diary marks (@pxref{Diary}). -@kindex a (Calendar mode) +@kindex a @r{(Calendar mode)} @findex list-calendar-holidays To get even more detailed information, use the @kbd{a} command, which displays a separate buffer containing a list of all holidays in the -current three-month range. +current three-month range. You can use @key{SPC} in the calendar window +to scroll that list. @findex holidays - You can display the list of holidays for the current month and the -preceding and succeeding months even if you don't have a calendar -window. Use the command @kbd{M-x holidays}. If you want the list of -holidays centered around a different month, use @kbd{C-u M-x holidays} -and type the month and year. + The command @kbd{M-x holidays} displays the list of holidays for the +current month and the preceding and succeeding months; this works even +if you don't have a calendar window. If you want the list of holidays +centered around a different month, use @kbd{C-u M-x holidays}, which +prompts for the month and year. + + The holidays known to Emacs include United States holidays and the +major Christian, Jewish, and Islamic holidays; also the solstices and +equinoxes. - The holidays known to Emacs include American holidays and the major -Christian, Jewish, and Islamic holidays; when floating point is available, -Emacs also knows about solstices and equinoxes. The dates used by Emacs -for holidays are based on @emph{current practice}, not historical fact. -Historically, for instance, the start of daylight savings time and even -its existence have varied from year to year. However present American -law mandates that daylight savings time begins on the first Sunday in -April; this is the definition that Emacs uses, even though it is wrong -for some prior years. +@findex list-holidays + The command @kbd{M-x list-holidays} displays the list of holidays for +a range of years. This function asks you for the starting and stopping +years, and allows you to chose all the holidays or one of several +categories of holidays. You can use this command even if you don't have +a calendar window. + + The dates used by Emacs for holidays are based on @emph{current +practice}, not historical fact. Historically, for instance, the start +of daylight savings time and even its existence have varied from year to +year, but present United States law mandates that daylight savings time +begins on the first Sunday in April. When the daylight savings rules +are set up for the United States, Emacs always uses the present +definition, even though it is wrong for some prior years. @node Sunrise/Sunset, Lunar Phases, Holidays, Calendar/Diary @subsection Times of Sunrise and Sunset -@cindex sunrise -@cindex sunset +@cindex sunrise and sunset - Emacs can tell you, to within a minute or two, the times of sunrise and -sunset for any date, if floating point is available. + Special calendar commands can tell you, to within a minute or two, the +times of sunrise and sunset for any date. @table @kbd @item S -Display times of sunrise and sunset for the date indicated by point +Display times of sunrise and sunset for the selected date (@code{calendar-sunrise-sunset}). +@item Button2 Sunrise/Sunset +Display times of sunrise and sunset for the date you click on. @item M-x sunrise-sunset Display times of sunrise and sunset for today's date. +@item C-u M-x sunrise-sunset +Display times of sunrise and sunset for a specified date. @end table -@kindex S (Calendar mode) +@kindex S @r{(Calendar mode)} @findex calendar-sunrise-sunset @findex sunrise-sunset - Move point to the date you want, and type @kbd{S}, to display the -@emph{local times} of sunrise and sunset in the echo area. + Within the calendar, to display the @emph{local times} of sunrise and +sunset in the echo area, move point to the date you want, and type +@kbd{S}. Alternatively, click @kbd{Button2} on the date, then choose +@kbd{Sunrise/Sunset} from the menu that appears. The command @kbd{M-x +sunrise-sunset} is available outside the calendar to display this +information for today's date or a specified date. To specify a date +other than today, use @kbd{C-u M-x sunrise-sunset}, which prompts for +the year, month, and day. - You can display the times of sunrise and sunset for the current date -even if you don't have a calendar window. Use the command @kbd{M-x -sunrise-sunset}. If you want the times of sunrise and sunset for a -different date, use @kbd{C-u M-x sunrise-sunset} and type the year, -month, and day. + You can display the times of sunrise and sunset for any location and +any date with @kbd{C-u C-u M-x sunrise-sunset}. This asks you for a +longitude, latitude, number of minutes difference from Coordinated +Universal Time, and date, and then tells you the times of sunrise and +sunset for that location on that date. Because the times of sunrise and sunset depend on the location on earth, you need to tell Emacs your latitude, longitude, and location -name. Here is an example of what to set: +name before using these commands. Here is an example of what to set: @vindex calendar-location-name @vindex calendar-longitude @@ -432,9 +547,9 @@ @code{calendar-longitude}. Your time zone also affects the local time of sunrise and sunset. -Emacs usually gets this information from the operating system, but if -these values are not what you want (or if the operating system does not -supply them), you'll need to set them yourself, like this: +Emacs usually gets time zone information from the operating system, but +if these values are not what you want (or if the operating system does +not supply them), you must set them yourself. Here is an example: @vindex calendar-time-zone @vindex calendar-standard-time-zone-name @@ -447,64 +562,59 @@ @noindent The value of @code{calendar-time-zone} is the number of minutes -difference between your local standard time and Universal Time -(Greenwich time). The values of @code{calendar-standard-time-zone-name} -and @code{calendar-daylight-time-zone-name} are the abbreviations used -in your time zone. +difference between your local standard time and Coordinated Universal +Time (Greenwich time). The values of +@code{calendar-standard-time-zone-name} and +@code{calendar-daylight-time-zone-name} are the abbreviations used in +your time zone. Emacs displays the times of sunrise and sunset +@emph{corrected for daylight savings time}. @xref{Daylight Savings}, +for how daylight savings time is determined. - Emacs displays the times of sunrise and sunset @emph{corrected for -daylight savings time} (this convenience is unusual; most tables of -sunrise and sunset use standard time). The default rule for the -starting and stopping dates of daylight savings time is the American -rule. @xref{Daylight Savings} - - You can display the times of sunrise and sunset for any location and -any date with @kbd{C-u C-u M-x sunrise-sunset}. Emacs asks you for a -longitude, latitude, number of minutes difference from Universal time, -and date, and then tells you the times of sunrise and sunset for that -location on that date. The times are usually given in the echo area, -but if the message is too long fit in one line, they are displayed in a -separate window. + As a user, you might find it convenient to set the calendar location +variables for your usual physical location in your @file{.emacs} file. +And when you install Emacs on a machine, you can create a +@file{default.el} file which sets them properly for the typical location +of most users of that machine. @xref{Init File}. @node Lunar Phases, Other Calendars, Sunrise/Sunset, Calendar/Diary @subsection Phases of the Moon @cindex phases of the moon @cindex moon, phases of - Emacs can tell you the dates and times of the phases of the moon (new -moon, first quarter, full moon, last quarter), if floating point is available. + These calendar commands display the dates and times of the phases of +the moon (new moon, first quarter, full moon, last quarter). This +feature is useful for debugging problems that ``depend on the phase of +the moon.'' @table @kbd @item M -List, in another window, the dates and times for all the quarters of the -moon for the three-month period shown in the calendar window -(@code{calendar-phases-of-moon}). +Display the dates and times for all the quarters of the moon for the +three-month period shown (@code{calendar-phases-of-moon}). @item M-x phases-of-moon -List dates and times of the quarters of the moon for three months around -today's date in another window. +Display dates and times of the quarters of the moon for three months around +today's date. @end table -@kindex M (Calendar mode) +@kindex M @r{(Calendar mode)} @findex calendar-phases-of-moon - Use the @kbd{M} command to display a separate buffer of the phases of -the moon for the current three-month range. The dates and times listed -are accurate to within a few minutes. + Within the calendar, use the @kbd{M} command to display a separate +buffer of the phases of the moon for the current three-month range. The +dates and times listed are accurate to within a few minutes. @findex phases-of-moon - You can display the list of the phases of the moon for the current -month and the preceding and succeeding months even if you don't have a -calendar window. Use the command @kbd{M-x phases-of-moon}. If you want -the phases of the moon centered around a different month, use @kbd{C-u -M-x phases-of-moon} and type the month and year. - -@vindex calendar-time-zone + Outside the calendar, use the command @kbd{M-x phases-of-moon} to +display the list of the phases of the moon for the current month and the +preceding and succeeding months. For information about a different +month, use @kbd{C-u M-x phases-of-moon}, which prompts for the month and +year. + The dates and times given for the phases of the moon are given in local time (corrected for daylight savings, when appropriate); but if -the variable @code{calendar-time-zone} is void, Universal Time (the -Greenwich time zone) is used. @xref{Daylight Savings} +the variable @code{calendar-time-zone} is void, Coordinated Universal +Time (the Greenwich time zone) is used. @xref{Daylight Savings}. -@node Other Calendars, Diary, Lunar Phases, Calendar/Diary -@subsection Our Calendar and Other Calendars +@node Other Calendars, Calendar Systems, Lunar Phases, Calendar/Diary +@subsection Conversion To and From Other Calendars @cindex Gregorian calendar The Emacs calendar displayed is @emph{always} the Gregorian calendar, @@ -512,80 +622,58 @@ the world today. However, this calendar did not exist before the sixteenth century and was not widely used before the eighteenth century; it did not fully displace the Julian calendar and gain universal -acceptance until the early twentieth century. This poses a problem for -the Emacs calendar: you can ask for the calendar of any month starting -with January, year 1 of the current era, but the calendar displayed is -the Gregorian, even for a date at which the Gregorian calendar did not -exist! +acceptance until the early twentieth century. The Emacs calendar can +display any month since January, year 1 of the current era, but the +calendar displayed is the Gregorian, even for a date at which the +Gregorian calendar did not exist. - Emacs knows about several different calendars, though, not just the -Gregorian calendar. The following commands describe the date indicated -by point in various calendar notations: + While Emacs cannot display other calendars, it can convert dates to +and from several other calendars. -@table @kbd -@item p c -Display ISO commercial calendar equivalent for selected day -(@code{calendar-print-iso-date}). -@item p j -Display Julian date for selected day (@code{calendar-print-julian-date}). -@item p a -Display astronomical (Julian) day number for selected day -(@code{calendar-print-astro-day-number}). -@item p h -Display Hebrew date for selected day (@code{calendar-print-hebrew-date}). -@item p i -Display Islamic date for selected day (@code{calendar-print-islamic-date}). -@item p f -Display French Revolutionary date for selected day -(@code{calendar-print-french-date}). -@item p m -Display Mayan date for selected day (@code{calendar-print-mayan-date}). -@end table +@menu +* Calendar Systems:: The calendars Emacs understands + (aside from Gregorian). +* To Other Calendar:: Converting the selected date to various calendars. +* From Other Calendar:: Moving to a date specified in another calendar. +* Mayan Calendar:: Moving to a date specified in a Mayan calendar. +@end menu If you are interested in these calendars, you can convert dates one at a time. Put point on the desired date of the Gregorian calendar and press the appropriate keys. The @kbd{p} is a mnemonic for ``print'' since Emacs ``prints' the equivalent date in the echo area. +@node Calendar Systems, To Other Calendar, Other Calendars, Other Calendars +@section Supported Calendar Systems -@kindex p c (Calendar mode) -@findex calendar-print-iso-date @cindex ISO commercial calendar The ISO commercial calendar is used largely in Europe. -@kindex p j (Calendar mode) -@findex calendar-print-julian-date @cindex Julian calendar The Julian calendar, named after Julius Caesar, was the one used in Europe throughout medieval times, and in many countries up until the nineteenth century. -@kindex p a (Calendar mode) -@findex calendar-print-astro-day-number @cindex Julian day numbers @cindex astronomical day numbers Astronomers use a simple counting of days elapsed since noon, Monday, January 1, 4713 B.C. on the Julian calendar. The number of days elapsed is called the @emph{Julian day number} or the @emph{Astronomical day number}. -@kindex p h (Calendar mode) -@findex calendar-print-hebrew-date @cindex Hebrew calendar - The Hebrew calendar is the one used to determine the dates of Jewish -holidays. Hebrew calendar dates begin and end at sunset. + The Hebrew calendar is used by tradition in the Jewish religion. The +Emacs calendar program uses the Hebrew calendar to determine the dates +of Jewish holidays. Hebrew calendar dates begin and end at sunset. -@kindex p i (Calendar mode) -@findex calendar-print-islamic-date @cindex Islamic calendar - The Islamic (Moslem) calendar is the one used to determine the dates -of Moslem holidays. There is no universal agreement in the Islamic -world about the calendar; Emacs uses a widely accepted version, but the -precise dates of Islamic holidays often depend on proclamation by -religious authorities, not on calculations. As a consequence, the -actual dates of occurrence can vary slightly from the dates computed by -Emacs. Islamic calendar dates begin and end at sunset. + The Islamic calendar is used in many predominantly Islamic countries. +Emacs uses it to determine the dates of Islamic holidays. There is no +universal agreement in the Islamic world about the calendar; Emacs uses +a widely accepted version, but the precise dates of Islamic holidays +often depend on proclamation by religious authorities, not on +calculations. As a consequence, the actual dates of observance can vary +slightly from the dates computed by Emacs. Islamic calendar dates begin +and end at sunset. -@kindex p f (Calendar mode) -@findex calendar-print-french-date @cindex French Revolutionary calendar The French Revolutionary calendar was created by the Jacobins after the 1789 revolution, to represent a more secular and nature-based view of the annual @@ -593,8 +681,6 @@ the metric system. The French government officially abandoned this calendar at the end of 1805. -@kindex p m (Calendar mode) -@findex calendar-print-mayan-date @cindex Mayan calendar The Maya of Central America used three separate, overlapping calendar systems, the @emph{long count}, the @emph{tzolkin}, and the @emph{haab}. @@ -602,40 +688,142 @@ exact correlation between the Mayan calendar and our calendar; Emacs uses the Goodman-Martinez-Thompson correlation in its calculations. - You can move to dates that you specify on the Commercial, Julian, -astronomical, Hebrew, Islamic, or French calendars: +@cindex Coptic calendar +@cindex Ethiopic calendar + The Copts use a calendar based on the ancient Egyptian solar calendar. +Their calendar consists of twelve 30-day months followed by an extra +five-day period. Once every fourth year they add a leap day to this +extra period to make it six days. The Ethiopic calendar is identical in +structure, but has different year numbers and month names. + +@cindex Persian calendar + The Persians use a solar calendar based on a design of Omar Khayyam. +Their calendar consists of twelve months of which the first six have 31 +days, the next five have 30 days, and the last has 29 in ordinary years +and 30 in leap years. Leap years occur in a complicated pattern every +four or five years. + +@cindex Chinese calendar + The Chinese calendar is a complicated system of lunar months arranged +into solar years. The years go in cycles of sixty, each year containing +either twelve months in an ordinary year or thirteen months in a leap +year; each month has either 29 or 30 days. Years, ordinary months, and +days are named by combining one of ten ``celestial stems'' with one of +twelve ``terrestrial branches'' for a total of sixty names that are +repeated in a cycle of sixty. + +@node To Other Calendar, From Other Calendar, Calendar Systems, Other Calendars +@section Converting To Other Calendars + + The following commands describe the selected date (the date at point) +in various other calendar systems: -@kindex g c (Calendar mode) +@table @kbd +@item Button2 Other Calendars +Display the date that you click on, expressed in various other calendars. +@kindex p @r{(Calendar mode)} +@findex calendar-print-iso-date +@item p c +Display ISO commercial calendar equivalent for selected day +(@code{calendar-print-iso-date}). +@findex calendar-print-julian-date +@item p j +Display Julian date for selected day (@code{calendar-print-julian-date}). +@findex calendar-print-astro-day-number +@item p a +Display astronomical (Julian) day number for selected day +(@code{calendar-print-astro-day-number}). +@findex calendar-print-hebrew-date +@item p h +Display Hebrew date for selected day (@code{calendar-print-hebrew-date}). +@findex calendar-print-islamic-date +@item p i +Display Islamic date for selected day (@code{calendar-print-islamic-date}). +@findex calendar-print-french-date +@item p f +Display French Revolutionary date for selected day +(@code{calendar-print-french-date}). +@findex calendar-print-chinese-date +@item p C +Display Chinese date for selected day +(@code{calendar-print-chinese-date}). +@findex calendar-print-coptic-date +@item p k +Display Coptic date for selected day +(@code{calendar-print-coptic-date}). +@findex calendar-print-ethiopic-date +@item p e +Display Ethiopic date for selected day +(@code{calendar-print-ethiopic-date}). +@findex calendar-print-persian-date +@item p p +Display Persian date for selected day +(@code{calendar-print-persian-date}). +@findex calendar-print-mayan-date +@item p m +Display Mayan date for selected day (@code{calendar-print-mayan-date}). +@end table + + If you are using X, the easiest way to translate a date into other +calendars is to click on it with @kbd{Button2}, then choose @kbd{Other +Calendars} from the menu that appears. This displays the equivalent +forms of the date in all the calendars Emacs understands, in the form of +a menu. (Choosing an alternative from this menu doesn't actually do +anything---the menu is used only for display.) + + Put point on the desired date of the Gregorian calendar, then type the +appropriate keys. The @kbd{p} is a mnemonic for ``print'' since Emacs +``prints'' the equivalent date in the echo area. + +@node From Other Calendar, Mayan Calendar, To Other Calendar, Other Calendars +@section Converting From Other Calendars + + You can use the other supported calendars to specify a date to move +to. This section describes the commands for doing this using calendars +other than Mayan; for the Mayan calendar, see the following section. + +@kindex g @var{char} @r{(Calendar mode)} @findex calendar-goto-iso-date -@kindex g j (Calendar mode) @findex calendar-goto-julian-date -@kindex g a (Calendar mode) @findex calendar-goto-astro-day-number -@kindex g h (Calendar mode) @findex calendar-goto-hebrew-date -@kindex g i (Calendar mode) @findex calendar-goto-islamic-date -@kindex g f (Calendar mode) @findex calendar-goto-french-date +@findex calendar-goto-chinese-date +@findex calendar-goto-persian-date +@findex calendar-goto-coptic-date +@findex calendar-goto-ethiopic-date @table @kbd @item g c -Move point to a date specified by the ISO commercial calendar +Move to a date specified in the ISO commercial calendar (@code{calendar-goto-iso-date}). @item g j -Move point to a date specified by the Julian calendar +Move to a date specified in the Julian calendar (@code{calendar-goto-julian-date}). @item g a -Move point to a date specified by astronomical (Julian) day number +Move to a date specified in astronomical (Julian) day number (@code{calendar-goto-astro-day-number}). @item g h -Move point to a date specified by the Hebrew calendar +Move to a date specified in the Hebrew calendar (@code{calendar-goto-hebrew-date}). @item g i -Move point to a date specified by the Islamic calendar +Move to a date specified in the Islamic calendar (@code{calendar-goto-islamic-date}). @item g f -Move point to a date specified by the French Revolutionary calendar +Move to a date specified in the French Revolutionary calendar (@code{calendar-goto-french-date}). +@item g C +Move to a date specified in the Chinese calendar +(@code{calendar-goto-chinese-date}). +@item g p +Move to a date specified in the Persian calendar +(@code{calendar-goto-persian-date}). +@item g k +Move to a date specified in the Coptic calendar +(@code{calendar-goto-coptic-date}). +@item g e +Move to a date specified in the Ethiopic calendar +(@code{calendar-goto-ethiopic-date}). @end table These commands ask you for a date on the other calendar, move point to @@ -655,50 +843,45 @@ this command first asks you for the date of death and the range of years, and then displays the list of yahrzeit dates. - Emacs also has many commands for movement on the Mayan calendars. +@node Mayan Calendar, Diary ,From Other Calendar ,Other Calendars +@subsection Converting from the Mayan Calendar + + Here are the commands to select dates based on the Mayan calendar: @table @kbd @item g m l -Move point to a date specified by the Mayan long count calendar +Move to a date specified by the long count calendar (@code{calendar-goto-mayan-long-count-date}). +@item g m n t +Move to the next occurrence of a place in the +tzolkin calendar (@code{calendar-next-tzolkin-date}). @item g m p t -Move point to the previous occurrence of a date specified by the Mayan +Move to the previous occurrence of a place in the tzolkin calendar (@code{calendar-previous-tzolkin-date}). -@item g m n t -Move point to the next occurrence of a date specified by the Mayan -tzolkin calendar (@code{calendar-next-tzolkin-date}). +@item g m n h +Move to the next occurrence of a place in the +haab calendar (@code{calendar-next-haab-date}). @item g m p h -Move point to the previous occurrence of a date specified by the Mayan +Move to the previous occurrence of a place in the haab calendar (@code{calendar-previous-haab-date}). -@item g m n h -Move point to the next occurrence of a date specified by the Mayan -haab calendar (@code{calendar-next-haab-date}). +@item g m n c +Move to the next occurrence of a place in the +calendar round (@code{calendar-next-calendar-round-date}). @item g m p c -Move point to the previous occurrence of a date specified by the Mayan +Move to the previous occurrence of a place in the calendar round (@code{calendar-previous-calendar-round-date}). -@item g m n c -Move point to the next occurrence of a date specified by the Mayan -calendar round (@code{calendar-next-calendar-round-date}). @end table @cindex Mayan long count To understand these commands, you need to understand the Mayan calendars. -The long count is a counting of days with units +The @dfn{long count} is a counting of days with these units: + +@display +1 kin = 1 day@ @ @ 1 uinal = 20 kin@ @ @ 1 tun = 18 uinal +1 katun = 20 tun@ @ @ 1 baktun = 20 katun +@end display -@table @asis -@item 1 kin -= 1 day -@item 1 uinal -= 20 kin -@item 1 tun -= 18 uinal -@item 1 katun -= 20 tun -@item 1 baktun -= 20 katun -@end table - -@kindex g m l (Calendar mode) +@kindex g m l @r{(Calendar mode)} @findex calendar-goto-mayan-long-count-date @noindent Thus, the long count date 12.16.11.16.6 means 12 baktun, 16 katun, 11 @@ -707,61 +890,58 @@ @kbd{g m l} command, type the Mayan long count date with the baktun, katun, tun, uinal, and kin separated by periods. -@kindex g m p t (Calendar mode) @findex calendar-previous-tzolkin-date -@kindex g m n t (Calendar mode) @findex calendar-next-tzolkin-date @cindex Mayan tzolkin calendar The Mayan tzolkin calendar is a cycle of 260 days formed by a pair of -independent cycles of 13 and 20 days. Like the haab cycle, this cycle -repeats endlessly, and you can go backward and forward to the previous -or next (respectively) point in the cycle. When you type @kbd{g m p t}, -Emacs asks you for a tzolkin date and moves point to the -previous occurrence of that date; type @kbd{g m n t} to go to the next -occurrence. +independent cycles of 13 and 20 days. Since this cycle repeats +endlessly, Emacs provides commands to move backward and forward to the +previous or next point in the cycle. Type @kbd{g m p t} to go to the +previous tzolkin date; Emacs asks you for a tzolkin date and moves point +to the previous occurrence of that date. Similarly, type @kbd{g m n t} +to go to the next occurrence of a tzolkin date. -@kindex g m p h (Calendar mode) @findex calendar-previous-haab-date -@kindex g m n h (Calendar mode) @findex calendar-next-haab-date @cindex Mayan haab calendar The Mayan haab calendar is a cycle of 365 days arranged as 18 months -of 20 days each, followed a 5-day monthless period. Since this cycle -repeats endlessly, Emacs lets you go backward and forward to the -previous or next (respectively) point in the cycle. Type @kbd{g m p h} -to go to the previous haab date; Emacs asks you for a haab date and -moves point to the previous occurrence of that date. Similarly, -type @kbd{g m n h} to go to the next haab date. +of 20 days each, followed a 5-day monthless period. Like the tzolkin +cycle, this cycle repeats endlessly, and there are commands to move +backward and forward to the previous or next point in the cycle. Type +@kbd{g m p h} to go to the previous haab date; Emacs asks you for a haab +date and moves point to the previous occurrence of that date. +Similarly, type @kbd{g m n h} to go to the next occurrence of a haab +date. -@kindex g m p c (Calendar mode) -@findex calendar-previous-calendar-round-date -@kindex g m n c (Calendar mode) +@c This is omitted because it is too long for smallbook format. +@c @findex calendar-previous-calendar-round-date @findex calendar-next-calendar-round-date @cindex Mayan calendar round The Maya also used the combination of the tzolkin date and the haab date. This combination is a cycle of about 52 years called a @emph{calendar round}. If you type @kbd{g m p c}, Emacs asks you for both a haab and a tzolkin date and then moves point to the previous -occurrence of that combination. Use @kbd{g m p c} to move point to the -next occurrence. Emacs signals an error if the haab/tzolkin date you -have typed cannot occur. +occurrence of that combination. Use @kbd{g m n c} to move point to the +next occurrence of a combination. These commands signal an error if the +haab/tzolkin date combination you have typed is impossible. - Emacs uses strict completion (@pxref{Completion}) whenever it asks you -to type a Mayan name, so you don't have to worry about spelling. + Emacs uses strict completion (@pxref{Completion}) whenever it +asks you to type a Mayan name, so you don't have to worry about +spelling. -@node Diary, Calendar Customization, Other Calendars, Calendar/Diary +@node Diary, Calendar Customization, Mayan Calendar, Calendar/Diary @subsection The Diary @cindex diary - Associated with the Emacs calendar is a diary that keeps track of -appointments or other events on a daily basis. To use the diary -feature, you must first create a @dfn{diary file} containing a list of -events and their dates. Then Emacs can automatically pick out and -display the events for today, for the immediate future, or for any -specified date.@refill + The Emacs diary keeps track of appointments or other events on a daily +basis, in conjunction with the calendar. To use the diary feature, you +must first create a @dfn{diary file} containing a list of events and +their dates. Then Emacs can automatically pick out and display the +events for today, for the immediate future, or for any specified +date. - By default, Emacs expects your diary file to be named @file{~/diary}. -It uses the same format as the @code{calendar} utility. A sample + By default, Emacs uses @file{~/diary} as the diary file. This is the +same file that the @code{calendar} utility uses. A sample @file{~/diary} file is: @example @@ -778,6 +958,10 @@ &* 15 time cards due. @end example +@noindent +This example uses extra spaces to align the event descriptions of most +of the entries. Such formatting is purely a matter of taste. + Although you probably will start by creating a diary manually, Emacs provides a number of commands to let you view, add, and change diary entries. You can also share diary entries with other users @@ -786,75 +970,75 @@ @menu * Diary Commands:: Viewing diary entries and associated calendar dates. * Format of Diary File:: Entering events in your diary. +* Date Formats:: Various ways you can specify dates. +* Adding to Diary:: Commands to create diary entries. * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc. @end menu @node Diary Commands, Format of Diary File, Diary, Diary @subsection Commands Displaying Diary Entries - Once you have created a @file{~/diary} file, you can view it within -Calendar mode. You can also view today's events independently of -Calendar mode. + Once you have created a @file{~/diary} file, you can use the calendar +to view it. You can also view today's events outside of Calendar mode. @table @kbd @item d -Display any diary entries for the selected date +Display all diary entries for the selected date (@code{view-diary-entries}). +@item Button2 Diary +Display all diary entries for the date you click on. @item s -Display entire diary file (@code{show-all-diary-entries}). +Display the entire diary file (@code{show-all-diary-entries}). @item m Mark all visible dates that have diary entries (@code{mark-diary-entries}). @item u -Unmark calendar window (@code{calendar-unmark}). +Unmark the calendar window (@code{calendar-unmark}). @item M-x print-diary-entries -Print a hard copy of the diary display as it appears. +Print hard copy of the diary display as it appears. @item M-x diary -Display any diary entries for today's date. +Display all diary entries for today's date. @end table -@kindex d (Calendar mode) +@kindex d @r{(Calendar mode)} @findex view-diary-entries - Displaying the diary entries with @kbd{d} shows in a separate window the -diary entries for the date indicated by point in the calendar window. The -mode line of the new window shows the date of the diary entries and any -holidays that fall on that date. + Displaying the diary entries with @kbd{d} shows in a separate window +the diary entries for the selected date in the calendar. The mode line +of the new window shows the date of the diary entries and any holidays +that fall on that date. If you specify a numeric argument with @kbd{d}, +it shows all the diary entries for that many successive days. Thus, +@kbd{2 d} displays all the entries for the selected date and for the +following day. - If you specify a numeric argument with @kbd{d}, then all the diary -entries for that many successive days are shown. Thus, @kbd{2 d} -displays all the entries for the selected date and for the following -day. + Another way to display the diary entries for a date is to click +@kbd{Button2} on the date, and then choose @kbd{Diary} from the menu +that appears. -@kindex m (Calendar mode) +@kindex m @r{(Calendar mode)} @findex mark-diary-entries -@kindex u (Calendar mode) +@kindex u @r{(Calendar mode)} @findex calendar-unmark - To get a broader overview of which days are mentioned in the diary, use -the @kbd{m} command to mark those days in the calendar window. The marks -appear next to the dates to which they apply. The @kbd{m} command affects -the dates currently visible and, if you scroll the calendar, newly visible -dates as well. The @kbd{u} command deletes all diary marks (and all -holiday marks too; @pxref{Holidays}), not only in the dates currently -visible, but dates that become visible when you scroll the calendar. + To get a broader view of which days are mentioned in the diary, use +the @kbd{m} command. This displays the dates that have diary entries +in a different face (or places a @samp{+} after these dates, if +display with multiple faces is not available). The command applies both +to the currently visible months and to other months that subsequently +become visible by scrolling. To turn marking off and erase the current +marks, type @kbd{u}, which also turns off holiday marks +(@pxref{Holidays}). -@kindex s (Calendar mode) +@kindex s @r{(Calendar mode)} @findex show-all-diary-entries - For more detailed information, use the @kbd{s} command, which displays -the entire diary file. + To see the full diary file, rather than just some of the entries, use +the @kbd{s} command. - Display of selected diary entries uses the selective display feature, -the same feature that Outline mode uses to show part of an outline -(@pxref{Outline Mode}). This involves hiding the diary entries that are -not relevant, by changing the preceding newline into an ASCII control-m -(code 015). The hidden lines are part of the buffer's text, but they -are invisible; they don't appear on the screen. When you save the diary -file, the control-m characters are saved as newlines; thus, the -invisible lines become ordinary lines in the file. + Display of selected diary entries uses the selective display feature +to hide entries that don't apply. @findex print-diary-entries - Because the diary buffer as you see it is an illusion, simply printing -the contents does not print what you see on your screen. So there is a -special command to print a hard copy of the buffer @emph{as it appears}; + The diary buffer as you see it is an illusion, so simply printing the +buffer does not print what you see on your screen. There is a special +command to print hard copy of the diary buffer @emph{as it appears}; this command is @kbd{M-x print-diary-entries}. It sends the data directly to the printer. You can customize it like @code{lpr-region} (@pxref{Hardcopy}). @@ -865,92 +1049,31 @@ few days as well; the variable @code{number-of-diary-entries} specifies how many days to include (@pxref{Customization}). - If you put in your @file{.emacs} file: - -@example -(diary) -@end example + If you put @code{(diary)} in your @file{.emacs} file, this +automatically displays a window with the day's diary entries, when you +enter Emacs. The mode line of the displayed window shows the date and +any holidays that fall on that date. -@noindent -it automatically displays a window with the day's diary entries, when -you enter Emacs. The mode line of the displayed window shows the date -and any holidays that fall on that date. - -@node Format of Diary File, Special Diary Entries, Diary Commands, Diary +@node Format of Diary File, Date Formats, Diary Commands, Diary @subsection The Diary File @cindex diary file @vindex diary-file Your @dfn{diary file} is a file that records events associated with -particular dates. The name of the diary file is specified by the variable -@code{diary-file}; @file{~/diary} is the default. You can use the same file -for the @code{calendar} utility program, since its formats are a subset of the -ones allowed by the Emacs Calendar. - - Each entry in the file describes one event and consists of one or more -lines. It always begins with a date specification at the left margin. -The rest of the entry is simply text to describe the event. If the -entry has more than one line, then the lines after the first must begin -with whitespace to indicate they continue a previous entry. - - Here are some sample diary entries, illustrating different ways of -formatting a date. The examples all show dates in American order (month, day, -year), but Calendar mode offers (day, month, year) ordering too. - -@example -4/20/93 Switch-over to new tabulation system -apr. 25 Start tabulating annual results -4/30 Results for April are due -*/25 Monthly cycle finishes -Friday Don't leave without backing up files -@end example - - The first entry appears only once, on April 20, 1993. The second and -third appear every year on the specified dates, and the fourth uses a -wildcard (asterisk) for the month, so it appears on the 25th of every -month. The final entry appears every week on Friday. +particular dates. The name of the diary file is specified by the +variable @code{diary-file}; @file{~/diary} is the default. The +@code{calendar} utility program supports a subset of the format allowed +by the Emacs diary facilities, so you can use that utility to view the +diary file, with reasonable results aside from the entries it cannot +understand. - You can also use just numbers to express a date, as in -@samp{@var{month}/@var{day}} or -@samp{@var{month}/@var{day}/@var{year}}. This must be followed by a -nondigit. In the date itself, @var{month} and @var{day} are numbers of -one or two digits. @var{year} is a number and may be abbreviated to the -last two digits; that is, you can use @samp{11/12/1989} or -@samp{11/12/89}. - - A date may be @dfn{generic}, or partially unspecified. Then the entry -applies to all dates that match the specification. If the date does -not contain a year, it is generic and applies to any year. -Alternatively, @var{month}, @var{day}, or @var{year} can be a @samp{*}; -this matches any month, day, or year, respectively. Thus, a diary entry -@samp{3/*/*} matches any day in March of any year.@refill - - Dates can also have the form @samp{@var{monthname} @var{day}} or -@samp{@var{monthname} @var{day}, @var{year}}, where the month's name can -be spelled in full or abbreviated to three characters (with or without a -period). Case is not significant. If the date does not contain a year, -it is generic and applies to any year. Also, @var{monthname}, -@var{day}, or @var{year} can be a @samp{*} which matches any month, day, -or year, respectively.@refill - -@vindex european-calendar-style -@findex european-calendar - If you prefer the European style of writing dates---in which the day -comes before the month---type @kbd{M-x european-calendar} while in the -calendar, or set the variable @code{european-calendar-style} to @code{t} -in your @file{.emacs} file @emph{before} the calendar or diary command. -This mode interprets all dates in the diary in the European manner, and -also uses European style for displaying diary dates. (Note that there -is no comma after the @var{monthname} in the European style.)@refill - -@findex american-calendar - To revert to the (default) American style of writing dates, type @kbd{M-x -american-calendar}. - - You can use the name of a day of the week as a generic date which -applies to any date falling on that day of the week. You can abbreviate -the day of the week to three letters (with or without a period) or spell -it in full; it need not be capitalized. + Each entry in the diary file describes one event and consists of one +or more lines. An entry always begins with a date specification at the +left margin. The rest of the entry is simply text to describe the +event. If the entry has more than one line, then the lines after the +first must begin with whitespace to indicate they continue a previous +entry. Lines that do not begin with valid dates and do not continue a +preceding entry are ignored. You can inhibit the marking of certain diary entries in the calendar window; to do this, insert an ampersand (@samp{&}) at the beginning of @@ -959,13 +1082,10 @@ window. Nonmarking entries are especially useful for generic entries that would otherwise mark many different dates. - Lines that do not begin with valid dates and do not continue a preceding -entry are ignored. - If the first line of a diary entry consists only of the date or day name with no following blanks or punctuation, then the diary window display doesn't include that line; only the continuation lines appear. -For example: +For example, this entry: @example 02/11/1989 @@ -988,16 +1108,78 @@ diary file, with portions of it concealed from view. This means, for instance, that the @kbd{C-f} (@code{forward-char}) command can put point at what appears to be the end of the line, but what is in reality the -middle of some concealed line. @emph{Be careful when editing the diary -entries!} Inserting additional lines or adding/deleting characters in the -middle of a visible line cannot cause problems. Watch out for @kbd{C-e} -(@code{end-of-line}), however; it may put you at the end of a concealed -line far from where point appears to be! Before editing the diary, it -is best to display the entire file with @kbd{s} -(@code{show-all-diary-entries}).@refill +middle of some concealed line. + + @emph{Be careful when editing the diary entries!} Inserting +additional lines or adding/deleting characters in the middle of a +visible line cannot cause problems, but editing at the end of a line may +not do what you expect. Deleting a line may delete other invisible +entries that follow it. Before editing the diary, it is best to display +the entire file with @kbd{s} (@code{show-all-diary-entries}). + +@node Date Formats,Adding to Diary ,Format of Diary File, Diary +@subsection Date Formats + + Here are some sample diary entries, illustrating different ways of +formatting a date. The examples all show dates in American order +(month, day, year), but Calendar mode supports European order (day, +month, year) as an option. + +@example +4/20/93 Switch-over to new tabulation system +apr. 25 Start tabulating annual results +4/30 Results for April are due +*/25 Monthly cycle finishes +Friday Don't leave without backing up files +@end example + + The first entry appears only once, on April 20, 1993. The second and +third appear every year on the specified dates, and the fourth uses a +wildcard (asterisk) for the month, so it appears on the 25th of every +month. The final entry appears every week on Friday. - While in the calendar, there are several commands to help you in making -entries to your diary. + You can use just numbers to express a date, as in +@samp{@var{month}/@var{day}} or @samp{@var{month}/@var{day}/@var{year}}. +This must be followed by a nondigit. In the date itself, @var{month} +and @var{day} are numbers of one or two digits. The optional @var{year} +is also a number, and may be abbreviated to the last two digits; that +is, you can use @samp{11/12/1989} or @samp{11/12/89}. + + Dates can also have the form @samp{@var{monthname} @var{day}} or +@samp{@var{monthname} @var{day}, @var{year}}, where the month's name can +be spelled in full or abbreviated to three characters (with or without a +period). Case is not significant. + + A date may be @dfn{generic}; that is, partially unspecified. Then the +entry applies to all dates that match the specification. If the date +does not contain a year, it is generic and applies to any year. +Alternatively, @var{month}, @var{day}, or @var{year} can be a @samp{*}; +this matches any month, day, or year, respectively. Thus, a diary entry +@samp{3/*/*} matches any day in March of any year; so does @samp{march +*}. + +@vindex european-calendar-style +@findex european-calendar +@findex american-calendar + If you prefer the European style of writing dates---in which the day +comes before the month---type @kbd{M-x european-calendar} while in the +calendar, or set the variable @code{european-calendar-style} to @code{t} +@emph{before} using any calendar or diary command. This mode interprets +all dates in the diary in the European manner, and also uses European +style for displaying diary dates. (Note that there is no comma after +the @var{monthname} in the European style.) To go back to the (default) +American style of writing dates, type @kbd{M-x american-calendar}. + + You can use the name of a day of the week as a generic date which +applies to any date falling on that day of the week. You can abbreviate +the day of the week to three letters (with or without a period) or spell +it in full; case is not significant. + +@node Adding to Diary, Special Diary Entries, Date Formats, Diary +@subsection Commands to Add to the Diary + + While in the calendar, there are several commands to create diary +entries: @table @kbd @item i d @@ -1010,63 +1192,71 @@ Add a diary entry for the selected day of the year (@code{insert-yearly-diary-entry}). @end table -@kindex i d (Calendar mode) +@kindex i d @r{(Calendar mode)} @findex insert-diary-entry - You can make a diary entry for a specific date by moving point to that -date in the calendar window and using the @kbd{i d} command. This -command displays the end of your diary file in another window and -inserts the date; you can then type the rest of the diary entry. + You can make a diary entry for a specific date by selecting that date +in the calendar window and typing the @kbd{i d} command. This command +displays the end of your diary file in another window and inserts the +date; you can then type the rest of the diary entry. -@kindex i w (Calendar mode) +@kindex i w @r{(Calendar mode)} @findex insert-weekly-diary-entry +@kindex i m @r{(Calendar mode)} +@findex insert-monthly-diary-entry +@kindex i y @r{(Calendar mode)} +@findex insert-yearly-diary-entry If you want to make a diary entry that applies to a specific day of -the week, move point to that day of the week (any occurrence will do) -and use the @kbd{i w} command. This displays the end of your diary file -in another window and inserts the day-of-week as a generic date; you can -then type the rest of the diary entry. +the week, select that day of the week (any occurrence will do) and type +@kbd{i w}. This inserts the day-of-week as a generic date; you can then +type the rest of the diary entry. You can make a monthly diary entry in +the same fashion. Select the day of the month, use the @kbd{i m} +command, and type rest of the entry. Similarly, you can insert a yearly +diary entry with the @kbd{i y} command. -@kindex i m (Calendar mode) -@findex insert-monthly-diary-entry -@kindex i y (Calendar mode) -@findex insert-yearly-diary-entry - You make a monthly diary entry in the same fashion. Move point to the -day of the month, use the @kbd{i m} command, and type the diary entry. -Similarly, you make a yearly diary entry with the @kbd{i y} command. - + All of the above commands make marking diary entries by default. To +make a nonmarking diary entry, give a numeric argument to the command. +For example, @kbd{C-u i w} makes a nonmarking weekly diary entry. + All of the above commands make marking diary entries. If you want the diary entry to be nonmarking, give a prefix argument to the command. For example, @kbd{C-u i w} makes a nonmarking, weekly diary entry. - If you modify the diary, be sure to write the file before exiting from the -calendar. - -@node Special Diary Entries,, Format of Diary File, Diary + When you modify the diary file, be sure to save the file before +exiting Emacs. + +@node Special Diary Entries,, Adding to Diary, Diary @subsection Special Diary Entries - In addition to entries based on calendar dates, your diary file can contain -entries for regularly occurring events such as anniversaries. These entries -are based on expressions (sexps) that Emacs evaluates as it scans the diary -file. Such an entry is indicated by @samp{%%} at the beginning (preceded by -@samp{&} for a nonmarking entry), followed by a sexp in parentheses. Calendar -mode offers commands to make it easier to put some of these special entries in -your diary. + In addition to entries based on calendar dates, the diary file can +contain @dfn{sexp entries} for regular events such as anniversaries. +These entries are based on Lisp expressions (sexps) that Emacs evaluates +as it scans the diary file. Instead of a date, a sexp entry contains +@samp{%%} followed by a Lisp expression which must begin and end with +parentheses. The Lisp expression determines which dates the entry +applies to. + + Calendar mode provides commands to insert certain commonly used +sexp entries: @table @kbd @item i a -Add an anniversary diary entry for the selected date (@code{insert-anniversary-diary-entry}). +Add an anniversary diary entry for the selected date +(@code{insert-anniversary-diary-entry}). @item i b -Add a block diary entry for the current region (@code{insert-block-diary-entry}). +Add a block diary entry for the current region +(@code{insert-block-diary-entry}). @item i c -Add a cyclic diary entry starting at the date (@code{insert-cyclic-diary-entry}). +Add a cyclic diary entry starting at the date +(@code{insert-cyclic-diary-entry}). @end table -@kindex i a (Calendar mode) +@kindex i a @r{(Calendar mode)} @findex insert-anniversary-diary-entry If you want to make a diary entry that applies to the anniversary of a specific date, move point to that date and use the @kbd{i a} command. This displays the end of your diary file in another window and inserts the anniversary description; you can then type the rest of the diary -entry. +entry. The entry looks like this: @findex diary-anniversary The effect of @kbd{i a} is to add a @code{diary-anniversary} sexp to your @@ -1077,24 +1267,17 @@ @end example @noindent -This entry applies to October 31 in any year after 1948; @samp{10 31 1948} -specifies the date. (If you are using the European calendar style, the month -and day are interchanged.) The reason this sexp requires a beginning -year is that advanced diary functions can use it to calculate the number of -elapsed years (@pxref{Sexp Diary Entries}).@refill +This entry applies to October 31 in any year after 1948; @samp{10 31 +1948} specifies the date. (If you are using the European calendar +style, the month and day are interchanged.) The reason this expression +requires a beginning year is that advanced diary functions can use it to +calculate the number of elapsed years. -@kindex i b (Calendar mode) -@findex insert-block-diary-entry - You can make a diary entry for a block of dates by setting the mark -at the date at one end of the block, moving point to the date at the other -end of the block, and using the @kbd{i b} command. This command -causes the end of your diary file to be displayed in another window and the -block description to be inserted; you can then type the diary entry. + A @dfn{block} diary entry applies to a specified range of consecutive +dates. Here is a block diary entry that applies to all dates from June +24, 1990 through July 10, 1990: @findex diary-block - Here is such a diary entry that applies to all dates from June 24, 1990 -through July 10, 1990: - @example %%(diary-block 6 24 1990 7 10 1990) Vacation @end example @@ -1104,16 +1287,19 @@ indicates the stopping date. (Again, if you are using the European calendar style, the month and day are interchanged.) -@kindex i c (Calendar mode) +@kindex i b @r{(Calendar mode)} +@findex insert-block-diary-entry + To insert a block entry, place point and the mark on the two +dates that begin and end the range, and type @kbd{i b}. This command +displays the end of your diary file in another window and inserts the +block description; you can then type the diary entry. + +@kindex i c @r{(Calendar mode)} @findex insert-cyclic-diary-entry - You can specify cyclic diary entries that repeat after a fixed -interval of days. Move point to the starting date and use the @kbd{i c} -command. After you specify the length of interval, this command -displays the end of your diary file in another window and inserts the -cyclic event description; you can then type the rest of the diary -entry. - - The sexp corresponding to the @kbd{i c} command looks like: + @dfn{Cyclic} diary entries repeat after a fixed interval of days. To +create one, select the starting date and use the @kbd{i c} command. The +command prompts for the length of interval, then inserts the entry, +which looks like this: @findex diary-cyclic @example @@ -1121,28 +1307,25 @@ @end example @noindent -which applies to March 1, 1990 and every 50th day following; @samp{3 1 1990} -specifies the starting date. (If you are using the European calendar style, -the month and day are interchanged.) +This entry applies to March 1, 1990 and every 50th day following; +@samp{3 1 1990} specifies the starting date. (If you are using the +European calendar style, the month and day are interchanged.) - All three of the these commands make marking diary entries. If you want the -diary entry to be nonmarking, give a numeric argument to the command. For -example, @kbd{C-u i a} makes a nonmarking anniversary diary -entry. + All three of these commands make marking diary entries. To insert a +nonmarking entry, give a numeric argument to the command. For example, +@kbd{C-u i a} makes a nonmarking anniversary diary entry. Marking sexp diary entries in the calendar is @emph{extremely} time-consuming, since every date visible in the calendar window must be individually checked. So it's a good idea to make sexp diary entries -nonmarking with @samp{&}. +nonmarking (with @samp{&}) when possible. - One sophisticated kind of sexp, a floating diary entry, has no corresponding -command. The floating diary entry specifies a regularly-occurring event -by offsets specified in days, weeks, and months. It is comparable to a -crontab entry interpreted by the @code{cron} utility on Unix systems.@refill - - Here is a nonmarking, floating diary entry that applies to the last -Thursday in November: - + Another sophisticated kind of sexp entry, a @dfn{floating} diary entry, +specifies a regularly occurring event by offsets specified in days, +weeks, and months. It is comparable to a crontab entry interpreted by +the @code{cron} utility. Here is a nonmarking, floating diary entry +that applies to the last Thursday in November: + @findex diary-float @example &%%(diary-float 11 4 -1) American Thanksgiving @@ -1186,7 +1369,7 @@ entry does @emph{not} apply to that date. -@node Calendar Customization,, Diary, Calendar/Diary +@node Calendar Customization,,Diary, Calendar/Diary @subsection Customizing the Calendar and Diary There are many customizations that you can use to make the calendar and @@ -1222,68 +1405,84 @@ @end example @noindent -they display both the calendar and diary windows whenever you start Emacs. +this displays both the calendar and diary windows whenever you start Emacs. @vindex view-calendar-holidays-initially Similarly, if you set the variable @code{view-calendar-holidays-initially} to @code{t}, entering the -calendar automatically displays a list of holidays for the current three -month period. The holiday list appears in a separate window.@refill - +calendar automatically displays a list of holidays for the current +three-month period. The holiday list appears in a separate +window. + @vindex mark-diary-entries-in-calendar - You can set the variable @code{mark-diary-entries-in-calendar} to @code{t} -in order to place a plus sign (@samp{+}) beside any dates with diary entries. -Whenever the calendar window is displayed or redisplayed, the diary entries -are automatically marked for holidays. + You can set the variable @code{mark-diary-entries-in-calendar} to +@code{t} in order to mark any dates with diary entries. This takes +effect whenever the calendar window contents are recomputed. There are +two ways of marking these dates: by changing the face (@pxref{Faces}), +if the display supports that, or by placing a plus sign (@samp{+}) +beside the date otherwise. @vindex mark-holidays-in-calendar Similarly, setting the variable @code{mark-holidays-in-calendar} to -@code{t} places an asterisk (@samp{*}) after all holiday dates visible -in the calendar window. +@code{t} marks holiday dates, either with a change of face or with an +asterisk (@samp{*}). + +@vindex calendar-holiday-marker +@vindex diary-entry-marker + The variable @code{calendar-holiday-marker} specifies how to mark a +date as being a holiday. Its value may be a character to insert next to +the date, or a face name to use for displaying the date. Likewise, the +variable @code{diary-entry-marker} specifies how to mark a date that has +diary entries. The calendar creates faces named @code{holiday-face} and +@code{diary-face} for these purposes; those symbols are the default +values of these variables, when Emacs supports multiple faces on your +terminal. @vindex calendar-load-hook - There are many customizations that you can make with the hooks -provided. For example, the variable @code{calendar-load-hook}, whose -default value is @code{nil}, is a normal hook run when the calendar -package is first loaded (before actually starting to display the -calendar). + The variable @code{calendar-load-hook} is a normal hook run when the +calendar package is first loaded (before actually starting to display +the calendar). @vindex initial-calendar-window-hook - The variable @code{initial-calendar-window-hook}, whose default value -is @code{nil}, is a normal hook run the first time the calendar window -is displayed. The function is invoked only when you first enter -Calendar mode, not when you redisplay an existing Calendar window. But -if you leave the calendar with the @kbd{q} command and reenter it, the -hook runs again.@refill + Starting the calendar runs the normal hook +@code{initial-calendar-window-hook}. Recomputation of the calendar +display does not run this hook. But if you leave the calendar with the +@kbd{q} command and reenter it, the hook runs again.@refill @vindex today-visible-calendar-hook - The variable @code{today-visible-calendar-hook}, whose default value -is @code{nil}, is a normal hook run after the calendar buffer has been -prepared with the calendar when the current date is visible in the -window. One use of this hook is to replace today's date with asterisks; -a function @code{calendar-star-date} is included for this purpose. In -your @file{.emacs} file, put:@refill + The variable @code{today-visible-calendar-hook} is a normal hook run +after the calendar buffer has been prepared with the calendar when the +current date is visible in the window. One use of this hook is to +replace today's date with asterisks; to do that, use the hook function +@code{calendar-star-date}. @findex calendar-star-date @example -(setq today-visible-calendar-hook 'calendar-star-date) +(add-hook 'today-visible-calendar-hook 'calendar-star-date) @end example @noindent -Another standard hook function adds asterisks around the current date. -Here's how to use it: +Another standard hook function marks the current date, either by +changing its face or by adding an asterisk. Here's how to use it: @findex calendar-mark-today @example -(setq today-visible-calendar-hook 'calendar-mark-today) +(add-hook 'today-visible-calendar-hook 'calendar-mark-today) @end example +@noindent +@vindex calendar-today-marker +The variable @code{calendar-today-marker} specifies how to mark today's +date. Its value should be a character to insert next to the date or a +face name to use for displaying the date. A face named +@code{calendar-today-face} is provided for this purpose; that symbol is +the default for this variable when Emacs supports multiple faces on your +terminal. + @vindex today-invisible-calendar-hook @noindent - A corresponding variable, @code{today-invisible-calendar-hook}, whose -default value is @code{nil}, is a normal hook run after the calendar -buffer text has been prepared, if the current date is @emph{not} visible -in the window.@refill + A similar normal hook, @code{today-invisible-calendar-hook} is run if +the current date is @emph{not} visible in the window. @node Holiday Customizing @subsubsection Customizing the Holidays @@ -1293,13 +1492,13 @@ @vindex hebrew-holidays @vindex islamic-holidays Emacs knows about holidays defined by entries on one of several lists. -You can customize theses lists of holidays to your own needs, adding -holidays or deleting lists of holidays. The lists of holidays that -Emacs uses are for general holidays (@code{general-holidays}), local -holidays (@code{local-holidays}), Christian holidays -(@code{christian-holidays}), Hebrew (Jewish) holidays -(@code{hebrew-holidays}), Islamic (Moslem) holidays -(@code{islamic-holidays}), and other holidays (@code{other-holidays}). +You can customize these lists of holidays to your own needs, adding or +deleting holidays. The lists of holidays that Emacs uses are for +general holidays (@code{general-holidays}), local holidays +(@code{local-holidays}), Christian holidays (@code{christian-holidays}), +Hebrew (Jewish) holidays (@code{hebrew-holidays}), Islamic (Moslem) +holidays (@code{islamic-holidays}), and other holidays +(@code{other-holidays}). @vindex general-holidays The general holidays are, by default, holidays common throughout the @@ -1314,10 +1513,10 @@ @vindex all-christian-calendar-holidays @vindex all-hebrew-calendar-holidays @vindex all-islamic-calendar-holidays - By default, Emacs does not consider all the holidays of these -religions, only those commonly found in secular calendars. For a more -extensive collection of religious holidays, you can set any (or all) of -the variables @code{all-christian-calendar-holidays}, + By default, Emacs does not include all the holidays of the religions +that it knows, only those commonly found in secular calendars. For a +more extensive collection of religious holidays, you can set any (or +all) of the variables @code{all-christian-calendar-holidays}, @code{all-hebrew-calendar-holidays}, or @code{all-islamic-calendar-holidays} to @code{t}. If you want to eliminate the religious holidays, set any or all of the corresponding @@ -1326,15 +1525,19 @@ @vindex other-holidays You can set the variable @code{other-holidays} to any list of -holidays. This list, normally empty, is intended for your use. +holidays. This list, normally empty, is intended for individual use. @cindex holiday forms Each of the lists (@code{general-holidays}, @code{local-holidays}, @code{christian-holidays}, @code{hebrew-holidays}, @code{islamic-holidays}, and @code{other-holidays}) is a list of @dfn{holiday forms}, each holiday form describing a holiday (or -sometimes a list of holidays). Holiday forms may have the following -formats: +sometimes a list of holidays). + + Here is a table of the possible kinds of holiday form. Day numbers +and month numbers count starting from 1, but ``dayname'' numbers +count Sunday as 0. The element @var{string} is always the +name of the holiday, as a string. @table @code @item (holiday-fixed @var{month} @var{day} @var{string}) @@ -1359,18 +1562,19 @@ numbers, @var{string} is the name of the holiday. @item (holiday-sexp @var{sexp} @var{string}) -@var{sexp} is a Lisp expression that should use the variable @code{year} -to compute the date of a holiday, or @code{nil} if the holiday doesn't -happen this year. The value represents the date as a list of the form +A date calculated by the Lisp expression @var{sexp}. The expression +should use the variable @code{year} to compute and return the date of a +holiday, or @code{nil} if the holiday doesn't happen this year. The +value of @var{sexp} must represent the date as a list of the form @code{(@var{month} @var{day} @var{year})}. @var{string} is the name of the holiday. -@item (if @var{boolean} @var{holiday-form} &optional @var{holiday-form}) -A choice between two holidays based on the value of @var{boolean}. +@item (if @var{condition} @var{holiday-form} &optional @var{holiday-form}) +A holiday that happens only if @var{condition} is true. -@item (@var{function} &optional @var{args}) -Dates requiring special computation; @var{args}, if any, are passed in -a list to the function @code{calendar-holiday-function-@var{function}}. +@item (@var{function} @r{[}@var{args}@r{]}) +A list of dates calculated by the function @var{function}, called with +arguments @var{args}. @end table For example, suppose you want to add Bastille Day, celebrated in @@ -1417,10 +1621,10 @@ Muharram), and Thomas Jefferson's birthday, which is 2 April 1743 on the Julian calendar. - To include a holiday conditionally, use either the @samp{if} or the -@samp{sexp} form. For example, American presidential elections occur on -the first Tuesday after the first Monday in November of years divisible -by 4: + To include a holiday conditionally, use either Emacs Lisp's @code{if} or the +@code{holiday-sexp} form. For example, American presidential elections +occur on the first Tuesday after the first Monday in November of years +divisible by 4: @smallexample (holiday-sexp (if (= 0 (% year 4)) @@ -1447,13 +1651,11 @@ Some holidays just don't fit into any of these forms because special calculations are involved in their determination. In such cases you -must write a Lisp function to do the calculation. To include -eclipses of the sun, for example, add @code{(eclipses)} to -@code{other-holidays} and write an Emacs Lisp function -@code{eclipses} that returns a (possibly -empty) list of the relevant Gregorian dates among the -range visible in the calendar window, with descriptive strings, like -this: +must write a Lisp function to do the calculation. To include eclipses, +for example, add @code{(eclipses)} to @code{other-holidays} +and write an Emacs Lisp function @code{eclipses} that returns a +(possibly empty) list of the relevant Gregorian dates among the range +visible in the calendar window, with descriptive strings, like this: @smallexample (((6 27 1991) "Lunar Eclipse") ((7 11 1991) "Solar Eclipse") ... ) @@ -1463,13 +1665,13 @@ @subsubsection Date Display Format @vindex calendar-date-display-form - You can customize the manner of displaying dates in the diary, -in mode lines, and in messages by setting -@code{calendar-date-display-form}. This variable is a list of -expressions that can involve the variables @code{month}, @code{day}, and -@code{year}, all numbers in string form, and @code{monthname} and -@code{dayname}, both alphabetic strings. In the American style, the -default value of this list is as follows: + You can customize the manner of displaying dates in the diary, in mode +lines, and in messages by setting @code{calendar-date-display-form}. +This variable holds a list of expressions that can involve the variables +@code{month}, @code{day}, and @code{year}, which are all numbers in +string form, and @code{monthname} and @code{dayname}, which are both +alphabetic strings. In the American style, the default value of this +list is as follows: @smallexample ((if dayname (concat dayname ", ")) monthname " " day ", " year) @@ -1482,6 +1684,7 @@ ((if dayname (concat dayname ", ")) day " " monthname " " year) @end smallexample ++@noindent The ISO standard date representation is this: @smallexample @@ -1499,23 +1702,24 @@ @subsubsection Time Display Format @vindex calendar-time-display-form - In the calendar, diary, and related buffers, Emacs displays times of -day in the conventional American style with the hours from 1 through 12, -minutes, and either @samp{am} or @samp{pm}. If you prefer the -``military'' (European) style of writing times---in which the hours go -from 00 to 23---you can alter the variable -@code{calendar-time-display-form}. This variable is a list of -expressions that can involve the variables @code{12-hours}, -@code{24-hours}, and @code{minutes}, all numbers in string form, and -@code{am-pm} and @code{time-zone}, both alphabetic strings. The default -definition of @code{calendar-time-display-form} is as follows: + The calendar and diary by default display times of day in the +conventional American style with the hours from 1 through 12, minutes, +and either @samp{am} or @samp{pm}. If you prefer the European style, +also known in the US as military, in which the hours go from 00 to 23, +you can alter the variable @code{calendar-time-display-form}. This +variable is a list of expressions that can involve the variables +@code{12-hours}, @code{24-hours}, and @code{minutes}, which are all +numbers in string form, and @code{am-pm} and @code{time-zone}, which are +both alphabetic strings. The default value of +@code{calendar-time-display-form} is as follows: @smallexample (12-hours ":" minutes am-pm (if time-zone " (") time-zone (if time-zone ")")) @end smallexample - Setting @code{calendar-time-display-form} to +@noindent +Here is a value that provides European style times: @smallexample (24-hours ":" minutes @@ -1541,13 +1745,14 @@ where you are; on these systems, Emacs gets the information it needs from the system automatically. If some or all of this information is missing, Emacs fills in the gaps with the rules currently used in -Cambridge, Massachusetts. If the default choice of rules is not -appropriate for your location, you can tell Emacs the rules to use by -setting certain variables. +Cambridge, Massachusetts. If the resulting rules are not what you want, +you can tell Emacs the rules to use by setting certain variables. @vindex calendar-daylight-savings-starts @vindex calendar-daylight-savings-ends - These variables are @code{calendar-daylight-savings-starts} and + If the default choice of rules is not appropriate for your location, +you can tell Emacs the rules to use by setting the variables +@code{calendar-daylight-savings-starts} and @code{calendar-daylight-savings-ends}. Their values should be Lisp expressions that refer to the variable @code{year}, and evaluate to the Gregorian date on which daylight savings time starts or (respectively) @@ -1555,10 +1760,10 @@ The values should be @code{nil} if your area does not use daylight savings time. - Emacs uses these expressions to determine the starting date of -daylight savings time for the holiday list and for correcting times of -day in the solar and lunar calculations. - + Emacs uses these expressions to determine the start and end dates of +daylight savings time as holidays and for correcting times of day in the +solar and lunar calculations. + The values for Cambridge, Massachusetts are as follows: @example @@ -1569,7 +1774,7 @@ @end example @noindent -i.e. the first 0th day (Sunday) of the fourth month (April) in +i.e., the first 0th day (Sunday) of the fourth month (April) in the year specified by @code{year}, and the last Sunday of the tenth month (October) of that year. If daylight savings time were changed to start on October 1, you would set @@ -1580,8 +1785,8 @@ @end example For a more complex example, suppose daylight savings time begins on -the first of Nisan on the Hebrew calendar. You would set -@code{calendar-daylight-savings-starts} as follows: +the first of Nisan on the Hebrew calendar. You should set +@code{calendar-daylight-savings-starts} to this value: @example (calendar-gregorian-from-absolute @@ -1598,15 +1803,18 @@ and @code{calendar-daylight-savings-ends} to @code{nil}. @vindex calendar-daylight-time-offset - This variable specifies the difference between daylight savings time and -standard time, measured in minutes. The value for Cambridge is 60. + The variable @code{calendar-daylight-time-offset} specifies the +difference between daylight savings time and standard time, measured in +minutes. The value for Cambridge, Massachusetts is 60. -@vindex calendar-daylight-savings-starts-time +@c @vindex calendar-daylight-savings-starts-time too long! @vindex calendar-daylight-savings-ends-time - These variables specify is the number of minutes after midnight local time -when the transition to and from daylight savings time should occur. For -Cambridge, both variables' values are 120. - + The variable @code{calendar-daylight-savings-starts-time} and the +variable @code{calendar-daylight-savings-ends-time} specify the number +of minutes after midnight local time when the transition to and from +daylight savings time should occur. For Cambridge, both variables' +values are 120. + @node Diary Customizing @subsubsection Customizing the Diary @@ -1626,11 +1834,11 @@ well as the command @kbd{M-x diary}. For example, the default value is 1, which says to display only the current day's diary entries. If the value is 2, both the current day's and the next day's entries are -displayed. The value can also be a vector of seven elements: if the -value is @code{[0 2 2 2 2 4 1]} then no diary entries appear on Sunday, -the current date's and the next day's diary entries appear Monday -through Thursday, Friday through Monday's entries appear on Friday, -while on Saturday only that day's entries appear. +displayed. The value can also be a vector of seven elements: for +example, if the value is @code{[0 2 2 2 2 4 1]} then no diary entries +appear on Sunday, the current date's and the next day's diary entries +appear Monday through Thursday, Friday through Monday's entries appear +on Friday, while on Saturday only that day's entries appear. @vindex print-diary-entries-hook @findex print-diary-entries @@ -1647,18 +1855,29 @@ @vindex diary-date-forms You can customize the form of dates in your diary file, if neither the standard American nor European styles suits your needs, by setting the -variable @code{diary-date-forms}. This variable is a list of forms of -dates recognized in the diary file. Each form is a list of regular -expressions (@pxref{Regexps}) and the variables @code{month}, -@code{day}, @code{year}, @code{monthname}, and @code{dayname}. The -variable @code{monthname} matches the name of the month, capitalized or -not, or its three-letter abbreviation, followed by a period or not; it -matches @samp{*}. Similarly, @code{dayname} matches the name of the -day, capitalized or not, or its three-letter abbreviation, followed by a -period or not. The variables @code{month}, @code{day}, and @code{year} -match those numerical values, preceded by arbitrarily many zeros; they -also match @samp{*}. The default value of @code{diary-date-forms} in -the American style is +variable @code{diary-date-forms}. This variable is a list of patterns +for recognizing a date. Each date pattern is a list whose elements may +be regular expressions (@pxref{Regexps}) or the symbols +@code{month}, @code{day}, @code{year}, @code{monthname}, and +@code{dayname}. All these elements serve as patterns that match certain +kinds of text in the diary file. In order for the date pattern, as a +whole, to match, all of its elements must match consecutively. + + A regular expression in a date pattern matches in its usual fashion, +using the standard syntax table altered so that @samp{*} is a word +constituent. + + The symbols @code{month}, @code{day}, @code{year}, @code{monthname}, +and @code{dayname} match the month number, day number, year number, +month name, and day name of the date being considered. The symbols that +match numbers allow leading zeros; those that match names allow +three-letter abbreviations and capitalization. All the symbols can +match @samp{*}; since @samp{*} in a diary entry means ``any day'', ``any +month'', and so on, it should match regardless of the date being +considered. + + The default value of @code{diary-date-forms} in the American style is +this: @example ((month "/" day "[^/0-9]") @@ -1674,14 +1893,16 @@ (@pxref{Syntax Tables,,,lispref,XEmacs Lisp Reference Manual}), but with the @samp{*} changed so that it is a word constituent.@refill - The forms on the list must be @emph{mutually exclusive} and must not -match any portion of the diary entry itself, just the date. If, to be -mutually exclusive, the pattern must match a portion of the diary entry -itself, the first element of the form @emph{must} be @code{backup}. -This causes the date recognizer to back up to the beginning of the -current word of the diary entry. Even if you use @code{backup}, the -form must absolutely not match more than a portion of the first word of -the diary entry. The default value of @code{diary-date-forms} in the + The date patterns in the list must be @emph{mutually exclusive} and +must not match any portion of the diary entry itself, just the date and +one character of whitespace. If, to be mutually exclusive, the pattern +must match a portion of the diary entry text---beyond the whitespace +that ends the date---then the first element of the date pattern +@emph{must} be @code{backup}. This causes the date recognizer to back +up to the beginning of the current word of the diary entry, after +finishing the match. Even if you use @code{backup}, the date pattern +must absolutely not match more than a portion of the first word of the +diary entry. The default value of @code{diary-date-forms} in the European style is this list: @example @@ -1693,56 +1914,45 @@ @end example @noindent -Notice the use of @code{backup} in the middle form because part of the -diary entry must be matched to distinguish this form from the following one. - +Notice the use of @code{backup} in the third pattern, because it needs +to match part of a word beyond the date itself to distinguish it from +the fourth pattern. + @node Hebrew/Islamic Entries @subsubsection Hebrew- and Islamic-Date Diary Entries Your diary file can have entries based on Hebrew or Islamic dates, as -well as entries based on our usual Gregorian calendar. However, because -the processing of such entries is time-consuming and most people don't -need them, you must customize the processing of your diary file to -specify that you want such entries recognized. If you want Hebrew-date -diary entries, for example, you must include these lines in your -@file{.emacs} file: - +well as entries based on the world-standard Gregorian calendar. +However, because recognition of such entries is time-consuming and most +people don't use them, you must explicitly enable their use. If you +want the diary to recognize Hebrew-date diary entries, for example, +you must do this: + @vindex nongregorian-diary-listing-hook @vindex nongregorian-diary-marking-hook @findex list-hebrew-diary-entries @findex mark-hebrew-diary-entries @smallexample -(setq nongregorian-diary-listing-hook 'list-hebrew-diary-entries) -(setq nongregorian-diary-marking-hook 'mark-hebrew-diary-entries) +(add-hook 'nongregorian-diary-listing-hook 'list-hebrew-diary-entries) +(add-hook 'nongregorian-diary-marking-hook 'mark-hebrew-diary-entries) @end smallexample @noindent -If you want Islamic-date entries, include these lines in your -@file{.emacs} file: +If you want Islamic-date entries, do this: @findex list-islamic-diary-entries @findex mark-islamic-diary-entries @smallexample -(setq nongregorian-diary-listing-hook 'list-islamic-diary-entries) -(setq nongregorian-diary-marking-hook 'mark-islamic-diary-entries) -@end smallexample - -@noindent -If you want both Hebrew- and Islamic-date entries, include these lines: - -@smallexample -(setq nongregorian-diary-listing-hook - '(list-hebrew-diary-entries list-islamic-diary-entries)) -(setq nongregorian-diary-marking-hook - '(mark-hebrew-diary-entries mark-islamic-diary-entries)) +(add-hook 'nongregorian-diary-listing-hook 'list-islamic-diary-entries) +(add-hook 'nongregorian-diary-marking-hook 'mark-islamic-diary-entries) @end smallexample Hebrew- and Islamic-date diary entries have the same formats as -Gregorian-date diary entries, except that the date must be preceded with -an @samp{H} for Hebrew dates and an @samp{I} for Islamic dates. -Moreover, because the Hebrew and Islamic month names are not uniquely -specified by the first three letters, you may not abbreviate them. For -example, a diary entry for the Hebrew date Heshvan 25 could look like +Gregorian-date diary entries, except that @samp{H} precedes a Hebrew +date and @samp{I} precedes an Islamic date. Moreover, because the +Hebrew and Islamic month names are not uniquely specified by the first +three letters, you may not abbreviate them. For example, a diary entry +for the Hebrew date Heshvan 25 could look like this: @smallexample HHeshvan 25 Happy Hebrew birthday! @@ -1750,7 +1960,8 @@ @noindent and would appear in the diary for any date that corresponds to Heshvan 25 -on the Hebrew calendar. Similarly, an Islamic-date diary entry might be +on the Hebrew calendar. And here is Islamic-date diary entry that matches +Dhu al-Qada 25: @smallexample IDhu al-Qada 25 Happy Islamic birthday! @@ -1763,19 +1974,24 @@ As with Gregorian-date diary entries, Hebrew- and Islamic-date entries are nonmarking if they are preceded with an ampersand (@samp{&}). - There are commands to help you in making Hebrew- and Islamic-date -entries to your diary: - + Here is a table of commands used in the calendar to create diary entries +that match the selected date and other dates that are similar in the Hebrew +or Islamic calendar: + @table @kbd @item i h d Add a diary entry for the Hebrew date corresponding to the selected date (@code{insert-hebrew-diary-entry}). @item i h m Add a diary entry for the day of the Hebrew month corresponding to the -selected date (@code{insert-monthly-hebrew-diary-entry}). +selected date (@code{insert-monthly-hebrew-diary-entry}). This diary +entry matches any date that has the same Hebrew day-within-month as the +selected date. @item i h y Add a diary entry for the day of the Hebrew year corresponding to the -selected date (@code{insert-yearly-hebrew-diary-entry}). +selected date (@code{insert-yearly-hebrew-diary-entry}). This diary +entry matches any date which has the same Hebrew month and day-within-month +as the selected date. @item i i d Add a diary entry for the Islamic date corresponding to the selected date (@code{insert-islamic-diary-entry}). @@ -1793,24 +2009,22 @@ @findex insert-islamic-diary-entry @findex insert-monthly-islamic-diary-entry @findex insert-yearly-islamic-diary-entry - These commands work exactly like the corresponding commands for ordinary -diary entries: Move point to a date in the calendar window and the above -commands insert the Hebrew or Islamic date (corresponding to the date -indicated by point) at the end of your diary file and you can then type the -diary entry. If you want the diary entry to be nonmarking, give a numeric -argument to the command. - + These commands work much like the corresponding commands for ordinary +diary entries: they apply to the date that point is on in the calendar +window, and what they do is insert just the date portion of a diary entry +at the end of your diary file. You must then insert the rest of the +diary entry. + @node Fancy Diary Display @subsubsection Fancy Diary Display @vindex diary-display-hook @findex simple-diary-display Diary display works by preparing the diary buffer and then running the -hook @code{diary-display-hook}. The default value of this hook hides -the irrelevant diary entries and then displays the buffer -(@code{simple-diary-display}). However, if you specify the hook as -follows, - +hook @code{diary-display-hook}. The default value of this hook +(@code{simple-diary-display}) hides the irrelevant diary entries and +then displays the buffer. However, if you specify the hook as follows, + @cindex diary buffer @findex fancy-diary-display @example @@ -1818,10 +2032,11 @@ @end example @noindent -then fancy mode displays diary entries and holidays by copying them into -a special buffer that exists only for display. Copying provides an -opportunity to change the displayed text to make it prettier---for -example, to sort the entries by the dates they apply to. +this enables fancy diary display. It displays diary entries and +holidays by copying them into a special buffer that exists only for the +sake of display. Copying to a separate buffer provides an opportunity +to change the displayed text to make it prettier---for example, to sort +the entries by the dates they apply to. As with simple diary display, you can print a hard copy of the buffer with @code{print-diary-entries}. To print a hard copy of a day-by-day @@ -1844,7 +2059,7 @@ @findex sort-diary-entries @example -(add-hook 'list-diary-entries-hook 'sort-diary-entries) +(add-hook 'list-diary-entries-hook 'sort-diary-entries t) @end example @noindent @@ -1855,24 +2070,20 @@ @node Included Diary Files @subsubsection Included Diary Files - If you use the fancy diary display, you can have diary entries from other -files included with your own by an ``include'' mechanism. This facility makes -possible the sharing of common diary files among groups of users. Lines in -the diary file of this form: - + Fancy diary display also has the ability to process included diary +files. This permits a group of people to share a diary file for events +that apply to all of them. Lines in the diary file of this form: + @smallexample #include "@var{filename}" @end smallexample @noindent includes the diary entries from the file @var{filename} in the fancy -diary buffer (because the ordinary diary buffer is just the buffer -associated with your diary file, you cannot use the include mechanism -unless you use the fancy diary buffer). The include mechanism is -recursive, by the way, so that included files can include other files, -and so on; you must be careful not to have a cycle of inclusions, of -course. To enable the include facility, add lines as follows to your -@file{.emacs} file: +diary buffer. The include mechanism is recursive, so that included files +can include other files, and so on; you must be careful not to have a +cycle of inclusions, of course. Here is how to enable the include +facility: @vindex list-diary-entries-hook @vindex mark-diary-entries-hook @@ -1883,6 +2094,9 @@ (add-hook 'mark-diary-entries-hook 'mark-included-diary-files) @end smallexample +The include mechanism works only with the fancy diary display, because +ordinary diary display shows the entries directly from your diary file. + @node Sexp Diary Entries @subsubsection Sexp Entries and the Fancy Diary Display @cindex sexp diary entries @@ -1940,9 +2154,16 @@ in the fancy diary display on September 8, 1990. The generality of sexp diary entries lets you specify any diary entry -that you can describe algorithmically. Suppose you get paid on the 21st -of the month if it is a weekday, and to the Friday before if the 21st is -on a weekend. The diary entry +that you can describe algorithmically. A sexp diary entry contains an +expression that computes whether the entry applies to any given date. +If its value is non-@code{nil}, the entry applies to that date; +otherwise, it does not. The expression can use the variable @code{date} +to find the date being considered; its value is a list (@var{month} +@var{day} @var{year}) that refers to the Gregorian calendar. + + Suppose you get paid on the 21st of the month if it is a weekday, and +on the Friday before if the 21st is on a weekend. Here is how to write +a sexp diary entry that matches those dates: @smallexample &%%(let ((dayname (calendar-day-of-week date)) @@ -1961,7 +2182,7 @@ @code{nil}, the entry does @emph{not} apply to that date. The following sexp diary entries take advantage of the ability (in the fancy -diary display) to concoct diary entries based on the date: +diary display) to concoct diary entries whose text varies based on the date: @findex diary-sunrise-sunset @findex diary-phases-of-moon @@ -2011,9 +2232,9 @@ diary display, the line @samp{&%%(diary-hebrew-date)} appears in the diary for any date, but does nothing particularly useful.) - There are a number of other available sexp diary entries that are important -to those who follow the Hebrew calendar: - + These functions can be used to construct sexp diary entries based on +the Hebrew calendar in certain standard ways: + @cindex rosh hodesh @findex diary-rosh-hodesh @cindex parasha, weekly @@ -2046,9 +2267,8 @@ @node Appt Customizing @subsubsection Customizing Appointment Reminders - You can specify exactly how Emacs reminds you of an appointment and -how far in advance it begins doing so. Here are the variables that you -can set: + You can specify exactly how Emacs reminds you of an appointment, and +how far in advance it begins doing so, by setting these variables: @vindex appt-message-warning-time @vindex appt-audible