(org-open-at-point): Fixed bug with matching a link.
Fixed buggy argument sequence in call to `org-view-tags'.
(org-compile-prefix-format): Set `org-prefix-has-tag'.
(org-prefix-has-tag): New variable.
(org-format-agenda-item): Remove tags from headline if
appropriate.
(org-agenda-remove-tags-when-in-prefix): New option.
\input texinfo @c -*-texinfo-*-@comment %**start of header@setfilename ../info/emacs-xtra@settitle Specialized Emacs Features@syncodeindex fn cp@syncodeindex vr cp@syncodeindex ky cp@comment %**end of header@copyingThis manual describes specialized features of Emacs.Copyright (C) 2004, 2005 Free Software Foundation, Inc.@quotationPermission is granted to copy, distribute and/or modify this documentunder the terms of the GNU Free Documentation License, Version 1.2 orany later version published by the Free Software Foundation; with noInvariant Sections, with the Front-Cover texts being ``A GNUManual'', and with the Back-Cover Texts as in (a) below. A copy of thelicense is included in the section entitled ``GNU Free DocumentationLicense'' in the Emacs manual.(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modifythis GNU Manual, like GNU software. Copies published by the FreeSoftware Foundation raise funds for GNU development.''This document is part of a collection distributed under the GNU FreeDocumentation License. If you want to distribute this documentseparately from the collection, you can do so by adding a copy of thelicense to the document, as described in section 6 of the license.@end quotation@end copying@dircategory Emacs@direntry* Emacs-Xtra: (emacs-xtra). Specialized Emacs features.@end direntry@titlepage@title Specialized Emacs Features@page@vskip 0pt plus 1filll@insertcopying@end titlepage@contents@ifnottex@node Top@top Specialized Emacs Features@insertcopying@end ifnottex@menu* Introduction:: What documentation belongs here?* Autorevert:: Auto Reverting non-file buffers.* Subdir switches:: Subdirectory switches in Dired.* Advanced Calendar/Diary Usage:: Advanced Calendar/Diary customization.* Index::@end menu@node Introduction@unnumbered IntroductionThis manual contains detailed information about various features thatare too specialized to be included in the Emacs manual. It isintended to be readable by anyone having a basic knowledge of Emacs.However, certain sections may be intended for a more specializedaudience, such as Elisp authors. This should be clearly pointed outat the beginning of these sections.This manual is intended as a complement, rather than an alternative,to other ways to gain a more detailed knowledge of Emacs than theEmacs manual can provide, such as browsing packages using @kbd{C-h p},accessing mode documentation using @kbd{C-h m} and browsing useroptions using Custom. Also, certain packages, or collections ofrelated features, have their own manuals. The present manual ismainly intended to be a collection of smaller specialized features,too small to get their own manual.Sections intended specifically for Elisp programmers can follow thestyle of the Elisp manual. Other sections should follow the style ofthe Emacs manual.@node Autorevert@chapter Auto Reverting non-file BuffersNormally Global Auto Revert Mode only reverts file buffers. There aretwo ways to auto-revert certain non-file buffers: enabling Auto RevertMode in those buffers (using @kbd{M-x auto-revert-mode}) and setting@code{global-auto-revert-non-file-buffers} to @code{t}. The latterenables Auto Reverting for all types of buffers for which it isimplemented, that is, for the types of buffers listed in the menubelow.Like file buffers, non-file buffers should normally not revert whileyou are working on them, or while they contain information that mightget lost after reverting. Therefore, they do not revert if they are``modified''. This can get tricky, because deciding when a non-filebuffer should be marked modified is usually more difficult than forfile buffers.Another tricky detail is that, for efficiency reasons, Auto Revertoften does not try to detect all possible changes in the buffer, onlychanges that are ``major'' or easy to detect. Hence, enablingauto-reverting for a non-file buffer does not always guarantee thatall information in the buffer is up to date and does not necessarilymake manual reverts useless.At the other extreme, certain buffers automatically auto-revert every@code{auto-revert-interval} seconds. (This currently only applies tothe Buffer Menu.) In this case, Auto Revert does not print anymessages while reverting, even when @code{auto-revert-verbose} isnon-@code{nil}.The details depend on the particular types of buffers and areexplained in the corresponding sections.@menu* Auto Reverting the Buffer Menu::* Auto Reverting Dired::* Supporting additional buffers::@end menu@node Auto Reverting the Buffer Menu@section Auto Reverting the Buffer MenuIf auto-reverting of non-file buffers is enabled, the Buffer Menuautomatically reverts every @code{auto-revert-interval} seconds,whether there is a need for it or not. (It would probably take longerto check whether there is a need than to actually revert.)If the Buffer Menu inappropriately gets marked modified, just revertit manually using @kbd{g} and auto-reverting will resume. However, ifyou marked certain buffers to get deleted or to be displayed, you haveto be careful, because reverting erases all marks. The fact thatadding marks sets the buffer's modified flag prevents Auto Revert fromautomatically erasing the marks.@node Auto Reverting Dired@section Auto Reverting Dired buffersAuto-reverting Dired buffers currently works on GNU or Unix styleoperating systems. It may not work satisfactorily on some othersystems.Dired buffers only auto-revert when the file list of the buffer's maindirectory changes. They do not auto-revert when information about aparticular file changes or when inserted subdirectories change. To besure that @emph{all} listed information is up to date, you have tomanually revert using @kbd{g}, @emph{even} if auto-reverting isenabled in the Dired buffer. Sometimes, you might get the impressionthat modifying or saving files listed in the main directory actuallydoes cause auto-reverting. This is because making changes to a file,or saving it, very often causes changes in the directory itself, forinstance, through backup files or auto-save files. However, this isnot guaranteed.If the Dired buffer is marked modified and there are no changes youwant to protect, then most of the time you can make auto-revertingresume by manually reverting the buffer using @kbd{g}. There is oneexception. If you flag or mark files, you can safely revert thebuffer. This will not erase the flags or marks (unless the markedfile has been deleted, of course). However, the buffer will staymodified, even after reverting, and auto-reverting will not resume.This is because, if you flag or mark files, you may be working on thebuffer and you might not want the buffer to change without warning.If you want auto-reverting to resume in the presence of marks andflags, mark the buffer non-modified using @kbd{M-~}. However, adding,deleting or changing marks or flags will mark it modified again.Remote Dired buffers are not auto-reverted. Neither are Dired buffersfor which you used shell wildcards or file arguments to list only someof the files. @samp{*Find*} and @samp{*Locate*} buffers do notauto-revert either.@node Supporting additional buffers@section Adding Support for Auto-Reverting additional Buffers.This section is intended for Elisp programmers who would like to addsupport for auto-reverting new types of buffers.To support auto-reverting the buffer must first of all have a@code{revert-buffer-function}. @xref{Definition ofrevert-buffer-function,, Reverting, elisp, the Emacs Lisp Reference Manual}.In addition, it @emph{must} have a @code{buffer-stale-function}.@defvar buffer-stale-functionThe value of this variable is a function to check whether a non-filebuffer needs reverting. This should be a function with one optionalargument @var{noconfirm}. The function should return non-@code{nil}if the buffer should be reverted. The buffer is current when thisfunction is called.While this function is mainly intended for use in auto-reverting, itcould be used for other purposes as well. For instance, ifauto-reverting is not enabled, it could be used to warn the user thatthe buffer needs reverting. The idea behind the @var{noconfirm}argument is that it should be @code{t} if the buffer is going to bereverted without asking the user and @code{nil} if the function isjust going to be used to warn the user that the buffer is out of date.In particular, for use in auto-reverting, @var{noconfirm} is @code{t}.If the function is only going to be used for auto-reverting, you canignore the @var{noconfirm} argument.If you just want to automatically auto-revert every@code{auto-revert-interval} seconds, use:@example(set (make-local-variable 'buffer-stale-function) #'(lambda (&optional noconfirm) 'fast))@end example@noindentin the buffer's mode function.The special return value @samp{fast} tells the caller that the needfor reverting was not checked, but that reverting the buffer is fast.It also tells Auto Revert not to print any revert messages, even if@code{auto-revert-verbose} is non-@code{nil}. This is important, asgetting revert messages every @code{auto-revert-interval} seconds canbe very annoying. The information provided by this return value couldalso be useful if the function is consulted for purposes other thanauto-reverting.@end defvarOnce the buffer has a @code{revert-buffer-function} and a@code{buffer-stale-function}, several problems usually remain.The buffer will only auto-revert if it is marked unmodified. Hence,you will have to make sure that various functions mark the buffermodified if and only if either the buffer contains information thatmight be lost by reverting or there is reason to believe that the usermight be inconvenienced by auto-reverting, because he is activelyworking on the buffer. The user can always override this by manuallyadjusting the modified status of the buffer. To support this, callingthe @code{revert-buffer-function} on a buffer that is markedunmodified should always keep the buffer marked unmodified.It is important to assure that point does not continuously jump aroundas a consequence of auto-reverting. Of course, moving point might beinevitable if the buffer radically changes.You should make sure that the @code{revert-buffer-function} does notprint messages that unnecessarily duplicate Auto Revert's own messagesif @code{auto-revert-verbose} is @code{t} and effectively override a@code{nil} value for @code{auto-revert-verbose}. Hence, adapting amode for auto-reverting often involves getting rid of such messages.This is especially important for buffers that automaticallyauto-revert every @code{auto-revert-interval} seconds.Also, you may want to update the documentation string of@code{global-auto-revert-non-file-buffers}.@ifinfoFinally, you should add a node to this chapter's menu. This node@end ifinfo@ifnotinfoFinally, you should add a section to this chapter. This section@end ifnotinfoshould at the very least make clear whether enabling auto-revertingfor the buffer reliably assures that all information in the buffer iscompletely up to date (or will be after @code{auto-revert-interval}seconds).@node Subdir switches@chapter Subdirectory Switches in DiredYou can insert subdirectories with specified @code{ls} switches inDired buffers, using @kbd{C-u i}. You can change the @code{ls}switches of an already inserted subdirectory using @kbd{C-u l}.In Emacs versions 22.1 and later, Dired remembers the switches, sothat reverting the buffer will not change them back to the maindirectory's switches. Deleting a subdirectory forgets about itsswitches.Using @code{dired-undo} (usually bound to @kbd{C-_} and @kbd{C-x u})to reinsert or delete subdirectories, that were inserted with explicitswitches, can bypass Dired's machinery for remembering (or forgetting)switches. Deleting a subdirectory using @code{dired-undo} does notforget its switches. When later reinserted using @kbd{i}, it will bereinserted using its old switches. Using @code{dired-undo} toreinsert a subdirectory that was deleted using the regularDired commands (not @code{dired-undo}) will originally insert it withits old switches. However, reverting the buffer will relist it usingthe buffer's default switches. If any of this yields problems, youcan easily correct the situation using @kbd{C-u i} or @kbd{C-u l}.Dired does not remember the @code{R} switch. Inserting a subdirectorywith switches that include the @code{R} switch is equivalent withinserting each of its subdirectories using all remaining switches.For instance, updating or killing a subdirectory that was insertedwith the @code{R} switch will not update or kill its subdirectories.The buffer's default switches do not affect subdirectories that wereinserted using explicitly specified switches. In particular,commands such as @kbd{s}, that change the buffer's switches do notaffect such subdirectories. (They do affect subdirectories withoutexplicitly assigned switches, however.)You can make Dired forget about all subdirectory switches and relistall subdirectories with the buffer's default switches using@kbd{M-x dired-reset-subdir-switches}. This also reverts the Dired buffer.@c Moved here from the Emacs Lisp Reference Manual, 2005-03-26.@node Advanced Calendar/Diary Usage@chapter Customizing the Calendar and Diary There are many customizations that you can use to make the calendar anddiary suit your personal tastes.@menu* Calendar Customizing:: Defaults you can set.* Holiday Customizing:: Defining your own holidays.* Date Display Format:: Changing the format.* Time Display Format:: Changing the format.* Daylight Savings:: Changing the default.* Diary Customizing:: Defaults you can set.* Hebrew/Islamic Entries:: How to obtain them.* Fancy Diary Display:: Enhancing the diary display, sorting entries, using included diary files.* Sexp Diary Entries:: Fancy things you can do.@end menu@node Calendar Customizing@section Customizing the Calendar@vindex calendar-holiday-marker@vindex diary-entry-marker The variable @code{calendar-holiday-marker} specifies how to mark adate as being a holiday. Its value may be a single-character stringto insert next to the date, or a face name to use for displaying thedate. Likewise, the variable @code{diary-entry-marker} specifies howto mark a date that has diary entries. The calendar creates facesnamed @code{holiday-face} and @code{diary-face} for these purposes;those symbols are the default values of these variables.@vindex calendar-load-hook The variable @code{calendar-load-hook} is a normal hook run when thecalendar package is first loaded (before actually starting to displaythe calendar).@vindex initial-calendar-window-hook Starting the calendar runs the normal hook@code{initial-calendar-window-hook}. Recomputation of the calendardisplay 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} is a normal hook runafter the calendar buffer has been prepared with the calendar when thecurrent date is visible in the window. One use of this hook is toreplace today's date with asterisks; to do that, use the hook function@code{calendar-star-date}.@findex calendar-star-date@example(add-hook 'today-visible-calendar-hook 'calendar-star-date)@end example@noindentAnother standard hook function marks the current date, either bychanging its face or by adding an asterisk. Here's how to use it:@findex calendar-mark-today@example(add-hook 'today-visible-calendar-hook 'calendar-mark-today)@end example@noindent@vindex calendar-today-markerThe variable @code{calendar-today-marker} specifies how to marktoday's date. Its value should be a single-character string to insertnext to the date or a face name to use for displaying the date. Aface named @code{calendar-today-face} is provided for this purpose;that symbol is the default for this variable.@vindex today-invisible-calendar-hook@noindent A similar normal hook, @code{today-invisible-calendar-hook} is run ifthe current date is @emph{not} visible in the window.@vindex calendar-move-hook Each of the calendar cursor motion commands runs the hook@code{calendar-move-hook} after it moves the cursor.@node Holiday Customizing@section Customizing the Holidays@vindex calendar-holidays@vindex christian-holidays@vindex hebrew-holidays@vindex islamic-holidays Emacs knows about holidays defined by entries on one of several lists.You can customize these lists of holidays to your own needs, adding ordeleting holidays. The lists of holidays that Emacs uses are forgeneral holidays (@code{general-holidays}), local holidays(@code{local-holidays}), Christian holidays (@code{christian-holidays}),Hebrew (Jewish) holidays (@code{hebrew-holidays}), Islamic (Muslim)holidays (@code{islamic-holidays}), and other holidays(@code{other-holidays}).@vindex general-holidays The general holidays are, by default, holidays common throughout theUnited States. To eliminate these holidays, set @code{general-holidays}to @code{nil}.@vindex local-holidays There are no default local holidays (but sites may supply some). Youcan set the variable @code{local-holidays} to any list of holidays, asdescribed below.@vindex all-christian-calendar-holidays@vindex all-hebrew-calendar-holidays@vindex all-islamic-calendar-holidays By default, Emacs does not include all the holidays of the religionsthat it knows, only those commonly found in secular calendars. For amore extensive collection of religious holidays, you can set any (orall) 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 toeliminate the religious holidays, set any or all of the correspondingvariables @code{christian-holidays}, @code{hebrew-holidays}, and@code{islamic-holidays} to @code{nil}.@refill@vindex other-holidays You can set the variable @code{other-holidays} to any list ofholidays. 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 (orsometimes a list of holidays). Here is a table of the possible kinds of holiday form. Day numbersand month numbers count starting from 1, but ``dayname'' numberscount Sunday as 0. The element @var{string} is always thename of the holiday, as a string.@table @code@item (holiday-fixed @var{month} @var{day} @var{string})A fixed date on the Gregorian calendar.@item (holiday-float @var{month} @var{dayname} @var{k} @var{string})The @var{k}th @var{dayname} in @var{month} on the Gregorian calendar(@var{dayname}=0 for Sunday, and so on); negative @var{k} means count backfrom the end of the month.@item (holiday-hebrew @var{month} @var{day} @var{string})A fixed date on the Hebrew calendar.@item (holiday-islamic @var{month} @var{day} @var{string})A fixed date on the Islamic calendar.@item (holiday-julian @var{month} @var{day} @var{string})A fixed date on the Julian calendar.@item (holiday-sexp @var{sexp} @var{string})A date calculated by the Lisp expression @var{sexp}. The expressionshould use the variable @code{year} to compute and return the date of aholiday, or @code{nil} if the holiday doesn't happen this year. Thevalue of @var{sexp} must represent the date as a list of the form@code{(@var{month} @var{day} @var{year})}.@item (if @var{condition} @var{holiday-form})A holiday that happens only if @var{condition} is true.@item (@var{function} @r{[}@var{args}@r{]})A list of dates calculated by the function @var{function}, called witharguments @var{args}.@end table For example, suppose you want to add Bastille Day, celebrated inFrance on July 14. You can do this as follows:@smallexample(setq other-holidays '((holiday-fixed 7 14 "Bastille Day")))@end smallexample@noindentThe holiday form @code{(holiday-fixed 7 14 "Bastille Day")} specifies thefourteenth day of the seventh month (July). Many holidays occur on a specific day of the week, at a specific timeof month. Here is a holiday form describing Hurricane Supplication Day,celebrated in the Virgin Islands on the fourth Monday in August:@smallexample(holiday-float 8 1 4 "Hurricane Supplication Day")@end smallexample@noindentHere the 8 specifies August, the 1 specifies Monday (Sunday is 0,Tuesday is 2, and so on), and the 4 specifies the fourth occurrence inthe month (1 specifies the first occurrence, 2 the second occurrence,@minus{}1 the last occurrence, @minus{}2 the second-to-last occurrence, andso on). You can specify holidays that occur on fixed days of the Hebrew,Islamic, and Julian calendars too. For example,@smallexample(setq other-holidays '((holiday-hebrew 10 2 "Last day of Hanukkah") (holiday-islamic 3 12 "Mohammed's Birthday") (holiday-julian 4 2 "Jefferson's Birthday")))@end smallexample@noindentadds the last day of Hanukkah (since the Hebrew months are numbered with1 starting from Nisan), the Islamic feast celebrating Mohammed'sbirthday (since the Islamic months are numbered from 1 starting withMuharram), and Thomas Jefferson's birthday, which is 2 April 1743 on theJulian calendar. To include a holiday conditionally, use either Emacs Lisp's @code{if} or the@code{holiday-sexp} form. For example, American presidential electionsoccur on the first Tuesday after the first Monday in November of yearsdivisible by 4:@smallexample(holiday-sexp '(if (= 0 (% year 4)) (calendar-gregorian-from-absolute (1+ (calendar-dayname-on-or-before 1 (+ 6 (calendar-absolute-from-gregorian (list 11 1 year))))))) "US Presidential Election")@end smallexample@noindentor@smallexample(if (= 0 (% displayed-year 4)) (fixed 11 (extract-calendar-day (calendar-gregorian-from-absolute (1+ (calendar-dayname-on-or-before 1 (+ 6 (calendar-absolute-from-gregorian (list 11 1 displayed-year))))))) "US Presidential Election"))@end smallexample Some holidays just don't fit into any of these forms because specialcalculations are involved in their determination. In such cases youmust 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 rangevisible in the calendar window, with descriptive strings, like this:@smallexample(((6 27 1991) "Lunar Eclipse") ((7 11 1991) "Solar Eclipse") ... )@end smallexample@node Date Display Format@section Date Display Format@vindex calendar-date-display-form You can customize the manner of displaying dates in the diary, in modelines, 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 instring form, and @code{monthname} and @code{dayname}, which are bothalphabetic strings. In the American style, the default value of thislist is as follows:@smallexample((if dayname (concat dayname ", ")) monthname " " day ", " year)@end smallexample@noindentwhile in the European style this value is the default:@smallexample((if dayname (concat dayname ", ")) day " " monthname " " year)@end smallexample@noindentThe ISO standard date representation is this:@smallexample(year "-" month "-" day)@end smallexample@noindentThis specifies a typical American format:@smallexample(month "/" day "/" (substring year -2))@end smallexample@node Time Display Format@section Time Display Format@vindex calendar-time-display-form The calendar and diary by default display times of day in theconventional 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}. Thisvariable is a list of expressions that can involve the variables@code{12-hours}, @code{24-hours}, and @code{minutes}, which are allnumbers in string form, and @code{am-pm} and @code{time-zone}, which areboth 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@noindentHere is a value that provides European style times:@smallexample(24-hours ":" minutes (if time-zone " (") time-zone (if time-zone ")"))@end smallexample@node Daylight Savings@section Daylight Savings Time@cindex daylight savings time Emacs understands the difference between standard time and daylightsavings time---the times given for sunrise, sunset, solstices,equinoxes, and the phases of the moon take that into account. The rulesfor daylight savings time vary from place to place and have also variedhistorically from year to year. To do the job properly, Emacs needs toknow which rules to use. Some operating systems keep track of the rules that apply to the placewhere you are; on these systems, Emacs gets the information it needsfrom the system automatically. If some or all of this information ismissing, Emacs fills in the gaps with the rules currently used inCambridge, Massachusetts, which is the center of GNU's world.@vindex calendar-daylight-savings-starts@vindex calendar-daylight-savings-ends 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 Lispexpressions that refer to the variable @code{year}, and evaluate to theGregorian date on which daylight savings time starts or (respectively)ends, in the form of a list @code{(@var{month} @var{day} @var{year})}.The values should be @code{nil} if your area does not use daylightsavings time. Emacs uses these expressions to determine the start and end dates ofdaylight savings time as holidays and for correcting times of day in thesolar and lunar calculations. The values for Cambridge, Massachusetts are as follows:@example@group(calendar-nth-named-day 1 0 4 year)(calendar-nth-named-day -1 0 10 year)@end group@end example@noindenti.e., the first 0th day (Sunday) of the fourth month (April) inthe year specified by @code{year}, and the last Sunday of the tenth month(October) of that year. If daylight savings time werechanged to start on October 1, you would set@code{calendar-daylight-savings-starts} to this:@example(list 10 1 year)@end example For a more complex example, suppose daylight savings time begins onthe first of Nisan on the Hebrew calendar. You should set@code{calendar-daylight-savings-starts} to this value:@example(calendar-gregorian-from-absolute (calendar-absolute-from-hebrew (list 1 1 (+ year 3760))))@end example@noindentbecause Nisan is the first month in the Hebrew calendar and the Hebrewyear differs from the Gregorian year by 3760 at Nisan. If there is no daylight savings time at your location, or if you wantall times in standard time, set @code{calendar-daylight-savings-starts}and @code{calendar-daylight-savings-ends} to @code{nil}.@vindex calendar-daylight-time-offset The variable @code{calendar-daylight-time-offset} specifies thedifference between daylight savings time and standard time, measured inminutes. The value for Cambridge is 60.@vindex calendar-daylight-savings-starts-time@vindex calendar-daylight-savings-ends-time The variable @code{calendar-daylight-savings-starts-time} and thevariable @code{calendar-daylight-savings-ends-time} specify the numberof minutes after midnight local time when the transition to and fromdaylight savings time should occur. For Cambridge, both variables'values are 120.@node Diary Customizing@section Customizing the Diary@vindex holidays-in-diary-buffer Ordinarily, the mode line of the diary buffer window indicates anyholidays that fall on the date of the diary entries. The process ofchecking for holidays can take several seconds, so including holidayinformation delays the display of the diary buffer noticeably. If you'dprefer to have a faster display of the diary buffer but without theholiday information, set the variable @code{holidays-in-diary-buffer} to@code{nil}.@refill@vindex number-of-diary-entries The variable @code{number-of-diary-entries} controls the number ofdays of diary entries to be displayed at one time. It affects theinitial display when @code{view-diary-entries-initially} is @code{t}, aswell as the command @kbd{M-x diary}. For example, the default value is1, which says to display only the current day's diary entries. If thevalue is 2, both the current day's and the next day's entries aredisplayed. The value can also be a vector of seven elements: forexample, if the value is @code{[0 2 2 2 2 4 1]} then no diary entriesappear on Sunday, the current date's and the next day's diary entriesappear Monday through Thursday, Friday through Monday's entries appearon Friday, while on Saturday only that day's entries appear.@vindex print-diary-entries-hook@findex print-diary-entries The variable @code{print-diary-entries-hook} is a normal hook runafter preparation of a temporary buffer containing just the diaryentries currently visible in the diary buffer. (The other, irrelevantdiary entries are really absent from the temporary buffer; in the diarybuffer, they are merely hidden.) The default value of this hook doesthe printing with the command @code{lpr-buffer}. If you want to use adifferent command to do the printing, just change the value of thishook. Other uses might include, for example, rearranging the lines intoorder by day and time.@vindex diary-date-forms You can customize the form of dates in your diary file, if neither thestandard American nor European styles suits your needs, by setting thevariable @code{diary-date-forms}. This variable is a list of patternsfor recognizing a date. Each date pattern is a list whose elements maybe regular expressions (@pxref{Regular Expressions,,, elisp, the EmacsLisp Reference Manual}) or the symbols @code{month}, @code{day},@code{year}, @code{monthname}, and @code{dayname}. All these elementsserve 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 elementsmust 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 wordconstituent. 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 thatmatch numbers allow leading zeros; those that match names allowthree-letter abbreviations and capitalization. All the symbols canmatch @samp{*}; since @samp{*} in a diary entry means ``any day'', ``anymonth'', and so on, it should match regardless of the date beingconsidered. The default value of @code{diary-date-forms} in the American style isthis:@example((month "/" day "[^/0-9]") (month "/" day "/" year "[^0-9]") (monthname " *" day "[^,0-9]") (monthname " *" day ", *" year "[^0-9]") (dayname "\\W"))@end example The date patterns in the list must be @emph{mutually exclusive} andmust not match any portion of the diary entry itself, just the date andone character of whitespace. If, to be mutually exclusive, the patternmust match a portion of the diary entry text---beyond the whitespacethat ends the date---then the first element of the date pattern@emph{must} be @code{backup}. This causes the date recognizer to backup to the beginning of the current word of the diary entry, afterfinishing the match. Even if you use @code{backup}, the date patternmust absolutely not match more than a portion of the first word of thediary entry. The default value of @code{diary-date-forms} in theEuropean style is this list:@example((day "/" month "[^/0-9]") (day "/" month "/" year "[^0-9]") (backup day " *" monthname "\\W+\\<[^*0-9]") (day " *" monthname " *" year "[^0-9]") (dayname "\\W"))@end example@noindentNotice the use of @code{backup} in the third pattern, because it needsto match part of a word beyond the date itself to distinguish it fromthe fourth pattern.@node Hebrew/Islamic Entries@section Hebrew- and Islamic-Date Diary Entries Your diary file can have entries based on Hebrew or Islamic dates, aswell as entries based on the world-standard Gregorian calendar.However, because recognition of such entries is time-consuming and mostpeople don't use them, you must explicitly enable their use. If youwant 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(add-hook 'nongregorian-diary-listing-hook 'list-hebrew-diary-entries)(add-hook 'nongregorian-diary-marking-hook 'mark-hebrew-diary-entries)@end smallexample@noindentIf you want Islamic-date entries, do this:@findex list-islamic-diary-entries@findex mark-islamic-diary-entries@smallexample(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 asGregorian-date diary entries, except that @samp{H} precedes a Hebrewdate and @samp{I} precedes an Islamic date. Moreover, because theHebrew and Islamic month names are not uniquely specified by the firstthree letters, you may not abbreviate them. For example, a diary entryfor the Hebrew date Heshvan 25 could look like this:@smallexampleHHeshvan 25 Happy Hebrew birthday!@end smallexample@noindentand would appear in the diary for any date that corresponds to Heshvan 25on the Hebrew calendar. And here is an Islamic-date diary entry that matchesDhu al-Qada 25:@smallexampleIDhu al-Qada 25 Happy Islamic birthday!@end smallexample As with Gregorian-date diary entries, Hebrew- and Islamic-date entriesare nonmarking if they are preceded with an ampersand (@samp{&}). Here is a table of commands used in the calendar to create diary entriesthat match the selected date and other dates that are similar in the Hebrewor Islamic calendar:@table @kbd@item i h dAdd a diary entry for the Hebrew date corresponding to the selected date(@code{insert-hebrew-diary-entry}).@item i h mAdd a diary entry for the day of the Hebrew month corresponding to theselected date (@code{insert-monthly-hebrew-diary-entry}). This diaryentry matches any date that has the same Hebrew day-within-month as theselected date.@item i h yAdd a diary entry for the day of the Hebrew year corresponding to theselected date (@code{insert-yearly-hebrew-diary-entry}). This diaryentry matches any date which has the same Hebrew month and day-within-monthas the selected date.@item i i dAdd a diary entry for the Islamic date corresponding to the selected date(@code{insert-islamic-diary-entry}).@item i i mAdd a diary entry for the day of the Islamic month corresponding to theselected date (@code{insert-monthly-islamic-diary-entry}).@item i i yAdd a diary entry for the day of the Islamic year corresponding to theselected date (@code{insert-yearly-islamic-diary-entry}).@end table@findex insert-hebrew-diary-entry@findex insert-monthly-hebrew-diary-entry@findex insert-yearly-hebrew-diary-entry@findex insert-islamic-diary-entry@findex insert-monthly-islamic-diary-entry@findex insert-yearly-islamic-diary-entry These commands work much like the corresponding commands for ordinarydiary entries: they apply to the date that point is on in the calendarwindow, and what they do is insert just the date portion of a diary entryat the end of your diary file. You must then insert the rest of thediary entry.@node Fancy Diary Display@section Fancy Diary Display@vindex diary-display-hook@findex simple-diary-display Diary display works by preparing the diary buffer and then running thehook @code{diary-display-hook}. The default value of this hook(@code{simple-diary-display}) hides the irrelevant diary entries andthen displays the buffer. However, if you specify the hook as follows,@cindex diary buffer@findex fancy-diary-display@example(add-hook 'diary-display-hook 'fancy-diary-display)@end example@noindentthis enables fancy diary display. It displays diary entries andholidays by copying them into a special buffer that exists only for thesake of display. Copying to a separate buffer provides an opportunityto change the displayed text to make it prettier---for example, to sortthe entries by the dates they apply to. As with simple diary display, you can print a hard copy of the bufferwith @code{print-diary-entries}. To print a hard copy of a day-by-daydiary for a week, position point on Sunday of that week, type@kbd{7 d}, and then do @kbd{M-x print-diary-entries}. As usual, theinclusion of the holidays slows down the display slightly; you can speedthings up by setting the variable @code{holidays-in-diary-buffer} to@code{nil}.@vindex diary-list-include-blanks Ordinarily, the fancy diary buffer does not show days for which there areno diary entries, even if that day is a holiday. If you want such days to beshown in the fancy diary buffer, set the variable@code{diary-list-include-blanks} to @code{t}.@refill@cindex sorting diary entries If you use the fancy diary display, you can use the normal hook@code{list-diary-entries-hook} to sort each day's diary entries by theirtime of day. Here's how:@findex sort-diary-entries@example(add-hook 'list-diary-entries-hook 'sort-diary-entries t)@end example@noindentFor each day, this sorts diary entries that begin with a recognizabletime of day according to their times. Diary entries without times comefirst within each day. Fancy diary display also has the ability to process included diaryfiles. This permits a group of people to share a diary file for eventsthat apply to all of them. Lines in the diary file of this form:@smallexample#include "@var{filename}"@end smallexample@noindentincludes the diary entries from the file @var{filename} in the fancydiary buffer. The include mechanism is recursive, so that included filescan include other files, and so on; you must be careful not to have acycle of inclusions, of course. Here is how to enable the includefacility:@vindex list-diary-entries-hook@vindex mark-diary-entries-hook@findex include-other-diary-files@findex mark-included-diary-files@smallexample(add-hook 'list-diary-entries-hook 'include-other-diary-files)(add-hook 'mark-diary-entries-hook 'mark-included-diary-files)@end smallexampleThe include mechanism works only with the fancy diary display, becauseordinary diary display shows the entries directly from your diary file.@node Sexp Diary Entries@section Sexp Entries and the Fancy Diary Display@cindex sexp diary entries Sexp diary entries allow you to do more than just have complicatedconditions under which a diary entry applies. If you use the fancydiary display, sexp entries can generate the text of the entry dependingon the date itself. For example, an anniversary diary entry can insertthe number of years since the anniversary date into the text of thediary entry. Thus the @samp{%d} in this dairy entry:@findex diary-anniversary@smallexample%%(diary-anniversary 10 31 1948) Arthur's birthday (%d years old)@end smallexample@noindentgets replaced by the age, so on October 31, 1990 the entry appears inthe fancy diary buffer like this:@smallexampleArthur's birthday (42 years old)@end smallexample@noindentIf the diary file instead contains this entry:@smallexample%%(diary-anniversary 10 31 1948) Arthur's %d%s birthday@end smallexample@noindentthe entry in the fancy diary buffer for October 31, 1990 appears like this:@smallexampleArthur's 42nd birthday@end smallexample Similarly, cyclic diary entries can interpolate the number of repetitionsthat have occurred:@findex diary-cyclic@smallexample%%(diary-cyclic 50 1 1 1990) Renew medication (%d%s time)@end smallexample@noindentlooks like this:@smallexampleRenew medication (5th time)@end smallexample@noindentin the fancy diary display on September 8, 1990. There is an early reminder diary sexp that includes its entry in thediary not only on the date of occurrence, but also on earlier dates.For example, if you want a reminder a week before your anniversary, youcan use@findex diary-remind@smallexample%%(diary-remind '(diary-anniversary 12 22 1968) 7) Ed's anniversary@end smallexample@noindentand the fancy diary will show@smallexampleEd's anniversary@end smallexample@noindentboth on December 15 and on December 22.@findex diary-date The function @code{diary-date} applies to dates described by a month,day, year combination, each of which can be an integer, a list ofintegers, or @code{t}. The value @code{t} means all values. Forexample,@smallexample%%(diary-date '(10 11 12) 22 t) Rake leaves@end smallexample@noindentcauses the fancy diary to show@smallexampleRake leaves@end smallexample@noindenton October 22, November 22, and December 22 of every year.@findex diary-float The function @code{diary-float} allows you to describe diary entriesthat apply to dates like the third Friday of November, or the lastTuesday in April. The parameters are the @var{month}, @var{dayname},and an index @var{n}. The entry appears on the @var{n}th @var{dayname}of @var{month}, where @var{dayname}=0 means Sunday, 1 means Monday, andso on. If @var{n} is negative it counts backward from the end of@var{month}. The value of @var{month} can be a list of months, a singlemonth, or @code{t} to specify all months. You can also use an optionalparameter @var{day} to specify the @var{n}th @var{dayname} of@var{month} on or after/before @var{day}; the value of @var{day} defaultsto 1 if @var{n} is positive and to the last day of @var{month} if@var{n} is negative. For example,@smallexample%%(diary-float t 1 -1) Pay rent@end smallexample@noindentcauses the fancy diary to show@smallexamplePay rent@end smallexample@noindenton the last Monday of every month. The generality of sexp diary entries lets you specify any diaryentry that you can describe algorithmically. A sexp diary entrycontains an expression that computes whether the entry applies to anygiven date. If its value is non-@code{nil}, the entry applies to thatdate; 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 Gregoriancalendar. The sexp diary entry applies to a date when the expression's valueis non-@code{nil}, but some values have more specific meanings. Ifthe value is a string, that string is a description of the event whichoccurs on that date. The value can also have the form@code{(@var{mark} . @var{string})}; then @var{mark} specifies how tomark the date in the calendar, and @var{string} is the description ofthe event. If @var{mark} is a single-character string, that characterappears next to the date in the calendar. If @var{mark} is a facename, the date is displayed in that face. If @var{mark} is@code{nil}, that specifies no particular highlighting for the date. Suppose you get paid on the 21st of the month if it is a weekday, andon the Friday before if the 21st is on a weekend. Here is how to writea sexp diary entry that matches those dates:@smallexample&%%(let ((dayname (calendar-day-of-week date)) (day (car (cdr date)))) (or (and (= day 21) (memq dayname '(1 2 3 4 5))) (and (memq day '(19 20)) (= dayname 5))) ) Pay check deposited@end smallexample The following sexp diary entries take advantage of the ability (in the fancydiary display) to concoct diary entries whose text varies based on the date:@findex diary-sunrise-sunset@findex diary-phases-of-moon@findex diary-day-of-year@findex diary-iso-date@findex diary-julian-date@findex diary-astro-day-number@findex diary-hebrew-date@findex diary-islamic-date@findex diary-french-date@findex diary-mayan-date@table @code@item %%(diary-sunrise-sunset)Make a diary entry for the local times of today's sunrise and sunset.@item %%(diary-phases-of-moon)Make a diary entry for the phases (quarters) of the moon.@item %%(diary-day-of-year)Make a diary entry with today's day number in the current year and the numberof days remaining in the current year.@item %%(diary-iso-date)Make a diary entry with today's equivalent ISO commercial date.@item %%(diary-julian-date)Make a diary entry with today's equivalent date on the Julian calendar.@item %%(diary-astro-day-number)Make a diary entry with today's equivalent astronomical (Julian) day number.@item %%(diary-hebrew-date)Make a diary entry with today's equivalent date on the Hebrew calendar.@item %%(diary-islamic-date)Make a diary entry with today's equivalent date on the Islamic calendar.@item %%(diary-french-date)Make a diary entry with today's equivalent date on the French Revolutionarycalendar.@item %%(diary-mayan-date)Make a diary entry with today's equivalent date on the Mayan calendar.@end table@noindentThus including the diary entry@example&%%(diary-hebrew-date)@end example@noindentcauses every day's diary display to contain the equivalent date on theHebrew calendar, if you are using the fancy diary display. (With simplediary display, the line @samp{&%%(diary-hebrew-date)} appears in thediary for any date, but does nothing particularly useful.) These functions can be used to construct sexp diary entries based onthe Hebrew calendar in certain standard ways:@cindex rosh hodesh@findex diary-rosh-hodesh@cindex parasha, weekly@findex diary-parasha@cindex candle lighting times@findex diary-sabbath-candles@cindex omer count@findex diary-omer@cindex yahrzeits@findex diary-yahrzeit@table @code@item %%(diary-rosh-hodesh)Make a diary entry that tells the occurrence and ritual announcement of eachnew Hebrew month.@item %%(diary-parasha)Make a Saturday diary entry that tells the weekly synagogue scripture reading.@item %%(diary-sabbath-candles)Make a Friday diary entry that tells the @emph{local time} of Sabbathcandle lighting.@item %%(diary-omer)Make a diary entry that gives the omer count, when appropriate.@item %%(diary-yahrzeit @var{month} @var{day} @var{year}) @var{name}Make a diary entry marking the anniversary of a date of death. The dateis the @emph{Gregorian} (civil) date of death. The diary entry appearson the proper Hebrew calendar anniversary and on the day before. (Inthe European style, the order of the parameters is changed to @var{day},@var{month}, @var{year}.)@end table All the functions documented above take an optional argument@var{mark} which specifies how to mark the date in the calendar display.If one of these functions decides that it applies to a certain date,it returns a value that contains @var{mark}.@node Index@unnumbered Index@printindex cp@bye@ignore arch-tag: 75c33f13-32c6-41b6-9537-847a312e2e49@end ignore