info/xemacs.info-14

   1 This is ../info/xemacs.info, produced by makeinfo version 4.0 from
   2 xemacs/xemacs.texi.
   3
   4 INFO-DIR-SECTION XEmacs Editor
   5 START-INFO-DIR-ENTRY
   6 * XEmacs: (xemacs).             XEmacs Editor.
   7 END-INFO-DIR-ENTRY
   8
   9    This file documents the XEmacs editor.
  10
  11    Copyright (C) 1985, 1986, 1988 Richard M. Stallman.  Copyright (C)
  12 1991, 1992, 1993, 1994 Lucid, Inc.  Copyright (C) 1993, 1994 Sun
  13 Microsystems, Inc.  Copyright (C) 1995 Amdahl Corporation.
  14
  15    Permission is granted to make and distribute verbatim copies of this
  16 manual provided the copyright notice and this permission notice are
  17 preserved on all copies.
  18
  19    Permission is granted to copy and distribute modified versions of
  20 this manual under the conditions for verbatim copying, provided also
  21 that the sections entitled "The GNU Manifesto", "Distribution" and "GNU
  22 General Public License" are included exactly as in the original, and
  23 provided that the entire resulting derived work is distributed under the
  24 terms of a permission notice identical to this one.
  25
  26    Permission is granted to copy and distribute translations of this
  27 manual into another language, under the above conditions for modified
  28 versions, except that the sections entitled "The GNU Manifesto",
  29 "Distribution" and "GNU General Public License" may be included in a
  30 translation approved by the author instead of in the original English.
  31
  32 \1f
  33 File: xemacs.info,  Node: Mail Mode,  Prev: Mail Headers,  Up: Sending Mail
  34
  35 Mail Mode
  36 =========
  37
  38    The major mode used in the `*mail*' buffer is Mail mode.  Mail mode
  39 is similar to Text mode, but several commands are provided on the `C-c'
  40 prefix.  These commands all deal specifically with editing or sending
  41 the message.
  42
  43 `C-c C-s'
  44      Send the message, and leave the `*mail*' buffer selected
  45      (`mail-send').
  46
  47 `C-c C-c'
  48      Send the message, and select some other buffer
  49      (`mail-send-and-exit').
  50
  51 `C-c C-f C-t'
  52      Move to the `To' header field, creating one if there is none
  53      (`mail-to').
  54
  55 `C-c C-f C-s'
  56      Move to the `Subject' header field, creating one if there is none
  57      (`mail-subject').
  58
  59 `C-c C-f C-c'
  60      Move to the `CC' header field, creating one if there is none
  61      (`mail-cc').
  62
  63 `C-c C-w'
  64      Insert the file `~/.signature' at the end of the message text
  65      (`mail-signature').
  66
  67 `C-c C-y'
  68      Yank the selected message (`mail-yank-original').
  69
  70 `C-c C-q'
  71      Fill all paragraphs of yanked old messages, each individually
  72      (`mail-fill-yanked-message').
  73
  74 `<button3>'
  75      Pops up a menu of useful mail-mode commands.
  76
  77    There are two ways to send a message.  `C-c C-c'
  78 (`mail-send-and-exit') is the usual way to send the message.  It sends
  79 the message and then deletes the window (if there is another window) or
  80 switches to another buffer.  It puts the `*mail*' buffer at the lowest
  81 priority for automatic reselection, since you are finished with using
  82 it.  `C-c C-s' (`mail-send') sends the message and marks the `*mail*'
  83 buffer unmodified, but leaves that buffer selected so that you can
  84 modify the message (perhaps with new recipients) and send it again.
  85
  86    Mail mode provides some other special commands that are useful for
  87 editing the headers and text of the message before you send it.  There
  88 are three commands defined to move point to particular header fields,
  89 all based on the prefix `C-c C-f' (`C-f' is for "field").  They are
  90 `C-c C-f C-t' (`mail-to') to move to the `To' field, `C-c C-f C-s'
  91 (`mail-subject') for the `Subject' field, and `C-c C-f C-c' (`mail-cc')
  92 for the `CC' field.  These fields have special motion commands because
  93 they are edited most frequently.
  94
  95    `C-c C-w' (`mail-signature') adds a standard piece of text at the
  96 end of the message to say more about who you are.  The text comes from
  97 the file `.signature' in your home directory.
  98
  99    When you use an Rmail command to send mail from the Rmail mail
 100 reader, you can use `C-c C-y' `mail-yank-original' inside the `*mail*'
 101 buffer to insert the text of the message you are replying to.  Normally
 102 Rmail indents each line of that message four spaces and eliminates most
 103 header fields.  A numeric argument specifies the number of spaces to
 104 indent.  An argument of just `C-u' says not to indent at all and not to
 105 eliminate anything.  `C-c C-y' always uses the current message from the
 106 `RMAIL' buffer, so you can insert several old messages by selecting one
 107 in `RMAIL', switching to `*mail*' and yanking it, then switching back
 108 to `RMAIL' to select another.
 109
 110    After using `C-c C-y', you can use the command `C-c C-q'
 111 (`mail-fill-yanked-message') to fill the paragraphs of the yanked old
 112 message or messages.  One use of `C-c C-q' fills all such paragraphs,
 113 each one separately.
 114
 115    Clicking the right mouse button in a mail buffer pops up a menu of
 116 the above commands, for easy access.
 117
 118    Turning on Mail mode (which `C-x m' does automatically) calls the
 119 value of `text-mode-hook', if it is not void or `nil', and then calls
 120 the value of `mail-mode-hook' if that is not void or `nil'.
 121
 122 \1f
 123 File: xemacs.info,  Node: Reading Mail,  Next: Calendar/Diary,  Prev: Sending Mail,  Up: Top
 124
 125 Reading Mail
 126 ************
 127
 128    XEmacs provides three separate mail-reading packages.  Each one
 129 comes with its own manual, which is included standard with the XEmacs
 130 distribution.
 131
 132    The recommended mail-reading package for new users is VM.  VM works
 133 with standard Unix-mail-format folders and was designed as a replacement
 134 for the older Rmail.
 135
 136    XEmacs also provides a sophisticated and comfortable front-end to the
 137 MH mail-processing system, called `mh-e'.  Unlike in other mail
 138 programs, folders in MH are stored as file-system directories, with
 139 each message occupying one (numbered) file.  This facilitates working
 140 with mail using shell commands, and many other features of MH are also
 141 designed to integrate well with the shell and with shell scripts.  Keep
 142 in mind, however, that in order to use mh-e you must have the MH
 143 mail-processing system installed on your computer.
 144
 145    Finally, XEmacs provides the Rmail package.  Rmail is (currently) the
 146 only mail reading package distributed with FSF GNU Emacs, and is
 147 powerful in its own right.  However, it stores mail folders in a special
 148 format called `Babyl', that is incompatible with all other
 149 frequently-used mail programs.  A utility program is provided for
 150 converting Babyl folders to standard Unix-mail format; however, unless
 151 you already have mail in Babyl-format folders, you should consider
 152 using VM or mh-e instead. (If at times you have to use FSF Emacs, it is
 153 not hard to obtain and install VM for that editor.)
 154
 155 \1f
 156 File: xemacs.info,  Node: Calendar/Diary,  Next: Sorting,  Prev: Reading Mail,  Up: Top
 157
 158 Calendar Mode and the Diary
 159 ===========================
 160
 161    Emacs provides the functions of a desk calendar, with a diary of
 162 planned or past events.  To enter the calendar, type `M-x calendar';
 163 this displays a three-month calendar centered on the current month, with
 164 point on the current date.  With a numeric argument, as in `C-u M-x
 165 calendar', it prompts you for the month and year to be the center of the
 166 three-month calendar.  The calendar uses its own buffer, whose major
 167 mode is Calendar mode.
 168
 169    `Button2' in the calendar brings up a menu of operations on a
 170 particular date; `Buttons3' brings up a menu of commonly used calendar
 171 features that are independent of any particular date.  To exit the
 172 calendar, type `q'.  *Note Customizing the Calendar and Diary:
 173 (elisp)Calendar, for customization information about the calendar and
 174 diary.
 175
 176 * Menu:
 177
 178 * Calendar Motion::        Moving through the calendar; selecting a date.
 179 * Scroll Calendar::        Bringing earlier or later months onto the screen.
 180 * Mark and Region::        Remembering dates, the mark ring.
 181 * General Calendar::       Exiting or recomputing the calendar.
 182 * LaTeX Calendar::         Print a calendar using LaTeX.
 183 * Holidays::               Displaying dates of holidays.
 184 * Sunrise/Sunset::         Displaying local times of sunrise and sunset.
 185 * Lunar Phases::           Displaying phases of the moon.
 186 * Other Calendars::        Converting dates to other calendar systems.
 187 * Diary::                  Displaying events from your diary.
 188 * Calendar Customization:: Altering the behavior of the features above.
 189
 190 \1f
 191 File: xemacs.info,  Node: Calendar Motion,  Next: Scroll Calendar,  Prev: Calendar/Diary,  Up: Calendar/Diary
 192
 193 Movement in the Calendar
 194 ------------------------
 195
 196    Calendar mode lets you move through the calendar in logical units of
 197 time such as days, weeks, months, and years.  If you move outside the
 198 three months originally displayed, the calendar display "scrolls"
 199 automatically through time to make the selected date visible.  Moving to
 200 a date lets you view its holidays or diary entries, or convert it to
 201 other calendars; moving longer time periods is also useful simply to
 202 scroll the calendar.
 203
 204 * Menu:
 205
 206 * Calendar Unit Motion::       Moving by days, weeks, months, and years.
 207 * Move to Beginning or End::   Moving to start/end of weeks, months, and years.
 208 * Specified Dates::            Moving to the current date or another
 209                                specific date.
 210
 211 \1f
 212 File: xemacs.info,  Node: Calendar Unit Motion,  Next: Move to Beginning or End,  Prev: Calendar Motion,  Up: Calendar Motion
 213
 214 Motion by Integral Days, Weeks, Months, Years
 215 .............................................
 216
 217    The commands for movement in the calendar buffer parallel the
 218 commands for movement in text.  You can move forward and backward by
 219 days, weeks, months, and years.
 220
 221 `C-f'
 222      Move point one day forward (`calendar-forward-day').
 223
 224 `C-b'
 225      Move point one day backward (`calendar-backward-day').
 226
 227 `C-n'
 228      Move point one week forward (`calendar-forward-week').
 229
 230 `C-p'
 231      Move point one week backward (`calendar-backward-week').
 232
 233 `M-}'
 234      Move point one month forward (`calendar-forward-month').
 235
 236 `M-{'
 237      Move point one month backward (`calendar-backward-month').
 238
 239 `C-x ]'
 240      Move point one year forward (`calendar-forward-year').
 241
 242 `C-x ['
 243      Move point one year backward (`calendar-backward-year').
 244
 245    The day and week commands are natural analogues of the usual Emacs
 246 commands for moving by characters and by lines.  Just as `C-n' usually
 247 moves to the same column in the following line, in Calendar mode it
 248 moves to the same day in the following week.  And `C-p' moves to the
 249 same day in the previous week.
 250
 251    The arrow keys are equivalent to `C-f', `C-b', `C-n' and `C-p', just
 252 as they normally are in other modes.
 253
 254    The commands for motion by months and years work like those for
 255 weeks, but move a larger distance.  The month commands `M-}' and `M-{'
 256 move forward or backward by an entire month's time.  The year commands
 257 `C-x ]' and `C-x [' move forward or backward a whole year.
 258
 259    The easiest way to remember these commands is to consider months and
 260 years analogous to paragraphs and pages of text, respectively.  But the
 261 commands themselves are not quite analogous.  The ordinary Emacs
 262 paragraph commands move to the beginning or end of a paragraph, whereas
 263 these month and year commands move by an entire month or an entire
 264 year, which usually involves skipping across the end of a month or year.
 265
 266    All these commands accept a numeric argument as a repeat count.  For
 267 convenience, the digit keys and the minus sign specify numeric
 268 arguments in Calendar mode even without the Meta modifier.  For example,
 269 `100 C-f' moves point 100 days forward from its present location.
 270
 271 \1f
 272 File: xemacs.info,  Node: Move to Beginning or End,  Next: Specified Dates,  Prev: Calendar Unit Motion,  Up: Calendar Motion
 273
 274 Beginning or End of Week, Month or Year
 275 .......................................
 276
 277    A week (or month, or year) is not just a quantity of days; we think
 278 of weeks (months, years) as starting on particular dates.  So Calendar
 279 mode provides commands to move to the beginning or end of a week, month
 280 or year:
 281
 282 `C-a'
 283      Move point to start of week (`calendar-beginning-of-week').
 284
 285 `C-e'
 286      Move point to end of week (`calendar-end-of-week').
 287
 288 `M-a'
 289      Move point to start of month (`calendar-beginning-of-month').
 290
 291 `M-e'
 292      Move point to end of month (`calendar-end-of-month').
 293
 294 `M-<'
 295      Move point to start of year (`calendar-beginning-of-year').
 296
 297 `M->'
 298      Move point to end of year (`calendar-end-of-year').
 299
 300    These commands also take numeric arguments as repeat counts, with the
 301 repeat count indicating how many weeks, months, or years to move
 302 backward or forward.
 303
 304    By default, weeks begin on Sunday.  To make them begin on Monday
 305 instead, set the variable `calendar-week-start-day' to 1.
 306
 307 \1f
 308 File: xemacs.info,  Node: Specified Dates,  Prev: Move to Beginning or End,  Up: Calendar Motion
 309
 310 Particular Dates
 311 ................
 312
 313    Calendar mode provides commands for moving to a particular date
 314 specified in various ways.
 315
 316 `g d'
 317      Move point to specified date (`calendar-goto-date').
 318
 319 `o'
 320      Center calendar around specified month (`calendar-other-month').
 321
 322 `.'
 323      Move point to today's date (`calendar-goto-today').
 324
 325    `g d' (`calendar-goto-date') prompts for a year, a month, and a day
 326 of the month, and then moves to that date.  Because the calendar
 327 includes all dates from the beginning of the current era, you must type
 328 the year in its entirety; that is, type `1990', not `90'.
 329
 330    `o' (`calendar-other-month') prompts for a month and year, then
 331 centers the three-month calendar around that month.
 332
 333    You can return to today's date with `.' (`calendar-goto-today').
 334
 335 \1f
 336 File: xemacs.info,  Node: Scroll Calendar,  Next: Mark and Region,  Prev: Calendar Motion,  Up: Calendar/Diary
 337
 338 Scrolling the Calendar through Time
 339 -----------------------------------
 340
 341    The calendar display scrolls automatically through time when you
 342 move out of the visible portion.  You can also scroll it manually.
 343 Imagine that the calendar window contains a long strip of paper with
 344 the months on it.  Scrolling it means moving the strip so that new
 345 months become visible in the window.
 346
 347 `C-x <'
 348      Scroll calendar one month forward (`scroll-calendar-left').
 349
 350 `C-x >'
 351      Scroll calendar one month backward (`scroll-calendar-right').
 352
 353 `C-v'
 354 `<NEXT>'
 355      Scroll calendar three months forward
 356      (`scroll-calendar-left-three-months').
 357
 358 `M-v'
 359 `<PRIOR>'
 360      Scroll calendar three months backward
 361      (`scroll-calendar-right-three-months').
 362
 363    The most basic calendar scroll commands scroll by one month at a
 364 time.  This means that there are two months of overlap between the
 365 display before the command and the display after.  `C-x <' scrolls the
 366 calendar contents one month to the left; that is, it moves the display
 367 forward in time.  `C-x >' scrolls the contents to the right, which
 368 moves backwards in time.
 369
 370    The commands `C-v' and `M-v' scroll the calendar by an entire
 371 "screenful"--three months--in analogy with the usual meaning of these
 372 commands.  `C-v' makes later dates visible and `M-v' makes earlier
 373 dates visible.  These commands take a numeric argument as a repeat
 374 count; in particular, since `C-u' multiplies the next command by four,
 375 typing `C-u C-v' scrolls the calendar forward by a year and typing `C-u
 376 M-v' scrolls the calendar backward by a year.
 377
 378    The function keys <NEXT> and <PRIOR> are equivalent to `C-v' and
 379 `M-v', just as they are in other modes.
 380
 381 \1f
 382 File: xemacs.info,  Node: Mark and Region,  Next: General Calendar,  Prev: Scroll Calendar,  Up: Calendar/Diary
 383
 384 The Mark and the Region
 385 -----------------------
 386
 387    The concept of the mark applies to the calendar just as to any other
 388 buffer, but it marks a _date_, not a _position_ in the buffer.  The
 389 region consists of the days between the mark and point (including the
 390 starting and stopping dates).
 391
 392 `C-SPC'
 393      Set the mark to today's date (`calendar-set-mark').
 394
 395 `C-@'
 396      The same.
 397
 398 `C-x C-x'
 399      Interchange mark and point (`calendar-exchange-point-and-mark').
 400
 401 `M-='
 402      Display the number of days in the current region
 403      (`calendar-count-days-region').
 404
 405    You set the mark in the calendar, as in any other buffer, by using
 406 `C-@' or `C-SPC' (`calendar-set-mark').  You return to the marked date
 407 with the command `C-x C-x' (`calendar-exchange-point-and-mark') which
 408 puts the mark where point was and point where mark was.  The calendar
 409 is scrolled as necessary, if the marked date was not visible on the
 410 screen.  This does not change the extent of the region.
 411
 412    To determine the number of days in the region, type `M-='
 413 (`calendar-count-days-region').  The numbers of days printed is
 414 _inclusive_; that is, it includes the days specified by mark and point.
 415
 416    The main use of the mark in the calendar is to remember dates that
 417 you may want to go back to.  To make this feature more useful, the mark
 418 ring (*note Mark Ring::) operates exactly as in other buffers:  Emacs
 419 remembers 16 previous locations of the mark.  To return to a marked
 420 date, type `C-u C-SPC' (or `C-u C-@'); this is the command
 421 `calendar-set-mark' given a numeric argument.  It moves point to where
 422 the mark was, restores the mark from the ring of former marks, and
 423 stores the previous point at the end of the mark ring.  So, repeated
 424 use of this command moves point through all the old marks on the ring,
 425 one by one.
 426
 427 \1f
 428 File: xemacs.info,  Node: General Calendar,  Next: LaTeX Calendar,  Prev: Mark and Region,  Up: Calendar/Diary
 429
 430 Miscellaneous Calendar Commands
 431 -------------------------------
 432
 433 `p d'
 434      Display day-in-year (`calendar-print-day-of-year').
 435
 436 `?'
 437      Briefly describe calendar commands (`describe-calendar-mode').
 438
 439 `C-c C-l'
 440      Regenerate the calendar window (`redraw-calendar').
 441
 442 `SPC'
 443      Scroll the next window (`scroll-other-window').
 444
 445 `q'
 446      Exit from calendar (`exit-calendar').
 447
 448    If you want to know how many days have elapsed since the start of
 449 the year, or the number of days remaining in the year, type the `p d'
 450 command (`calendar-print-day-of-year').  This displays both of those
 451 numbers in the echo area.
 452
 453    To display a brief description of the calendar commands, type `?'
 454 (`describe-calendar-mode').  For a fuller description, type `C-h m'.
 455
 456    You can use `SPC' (`scroll-other-window') to scroll the other
 457 window.  This is handy when you display a list of holidays or diary
 458 entries in another window.
 459
 460    If the calendar window text gets corrupted, type `C-c C-l'
 461 (`redraw-calendar') to redraw it.  (This can only happen if you use
 462 non-Calendar-mode editing commands.)
 463
 464    In Calendar mode, you can use `SPC' (`scroll-other-window') to
 465 scroll the other window.  This is handy when you display a list of
 466 holidays or diary entries in another window.
 467
 468    To exit from the calendar, type `q' (`exit-calendar').  This buries
 469 all buffers related to the calendar, selecting other buffers.  (If a
 470 frame contains a dedicated calendar window, exiting from the calendar
 471 iconifies that frame.)
 472
 473 \1f
 474 File: xemacs.info,  Node: LaTeX Calendar,  Next: Holidays,  Prev: General Calendar,  Up: Calendar/Diary
 475
 476 LaTeX Calendar
 477 ==============
 478
 479    The Calendar LaTeX commands produce a buffer of LaTeX code that
 480 prints as a calendar.  Depending on the command you use, the printed
 481 calendar covers the day, week, month or year that point is in.
 482
 483 `t m'
 484      Generate a one-month calendar (`cal-tex-cursor-month').
 485
 486 `t M'
 487      Generate a sideways-printing one-month calendar
 488      (`cal-tex-cursor-month-landscape').
 489
 490 `t d'
 491      Generate a one-day calendar (`cal-tex-cursor-day').
 492
 493 `t w 1'
 494      Generate a one-page calendar for one week (`cal-tex-cursor-week').
 495
 496 `t w 2'
 497      Generate a two-page calendar for one week (`cal-tex-cursor-week2').
 498
 499 `t w 3'
 500      Generate an ISO-style calendar for one week
 501      (`cal-tex-cursor-week-iso').
 502
 503 `t w 4'
 504      Generate a calendar for one Monday-starting week
 505      (`cal-tex-cursor-week-monday').
 506
 507 `t f w'
 508      Generate a Filofax-style two-weeks-at-a-glance calendar
 509      (`cal-tex-cursor-filofax-2week').
 510
 511 `t f W'
 512      Generate a Filofax-style one-week-at-a-glance calendar
 513      (`cal-tex-cursor-filofax-week').
 514
 515 `t y'
 516      Generate a calendar for one year (`cal-tex-cursor-year').
 517
 518 `t Y'
 519      Generate a sideways-printing calendar for one year
 520      (`cal-tex-cursor-year-landscape').
 521
 522 `t f y'
 523      Generate a Filofax-style calendar for one year
 524      (`cal-tex-cursor-filofax-year').
 525
 526    Some of these commands print the calendar sideways (in "landscape
 527 mode"), so it can be wider than it is long.  Some of them use Filofax
 528 paper size (3.75in x 6.75in).  All of these commands accept a prefix
 529 argument which specifies how many days, weeks, months or years to print
 530 (starting always with the selected one).
 531
 532    If the variable `cal-tex-holidays' is non-`nil' (the default), then
 533 the printed calendars show the holidays in `calendar-holidays'.  If the
 534 variable `cal-tex-diary' is non-`nil' (the default is `nil'), diary
 535 entries are included also (in weekly and monthly calendars only).
 536
 537 \1f
 538 File: xemacs.info,  Node: Holidays,  Next: Sunrise/Sunset,  Prev: LaTeX Calendar,  Up: Calendar/Diary
 539
 540 Holidays
 541 --------
 542
 543    The Emacs calendar knows about all major and many minor holidays,
 544 and can display them.
 545
 546 `h'
 547      Display holidays for the selected date
 548      (`calendar-cursor-holidays').
 549
 550 `Button2 Holidays'
 551      Display any holidays for the date you click on.
 552
 553 `x'
 554      Mark holidays in the calendar window (`mark-calendar-holidays').
 555
 556 `u'
 557      Unmark calendar window (`calendar-unmark').
 558
 559 `a'
 560      List all holidays for the displayed three months in another window
 561      (`list-calendar-holidays').
 562
 563 `M-x holidays'
 564      List all holidays for three months around today's date in another
 565      window.
 566
 567 `M-x list-holidays'
 568      List holidays in another window for a specified range of years.
 569
 570    To see if any holidays fall on a given date, position point on that
 571 date in the calendar window and use the `h' command.  Alternatively,
 572 click on that date with `Button2' and then choose `Holidays' from the
 573 menu that appears.  Either way, this displays the holidays for that
 574 date, in the echo area if they fit there, otherwise in a separate
 575 window.
 576
 577    To view the distribution of holidays for all the dates shown in the
 578 calendar, use the `x' command.  This displays the dates that are
 579 holidays in a different face (or places a `*' after these dates, if
 580 display with multiple faces is not available). The command applies both
 581 to the currently visible months and to other months that subsequently
 582 become visible by scrolling.  To turn marking off and erase the current
 583 marks, type `u', which also erases any diary marks (*note Diary::).
 584
 585    To get even more detailed information, use the `a' command, which
 586 displays a separate buffer containing a list of all holidays in the
 587 current three-month range.  You can use <SPC> in the calendar window to
 588 scroll that list.
 589
 590    The command `M-x holidays' displays the list of holidays for the
 591 current month and the preceding and succeeding months; this works even
 592 if you don't have a calendar window.  If you want the list of holidays
 593 centered around a different month, use `C-u M-x holidays', which
 594 prompts for the month and year.
 595
 596    The holidays known to Emacs include United States holidays and the
 597 major Christian, Jewish, and Islamic holidays; also the solstices and
 598 equinoxes.
 599
 600    The command `M-x list-holidays' displays the list of holidays for a
 601 range of years.  This function asks you for the starting and stopping
 602 years, and allows you to choose all the holidays or one of several
 603 categories of holidays.  You can use this command even if you don't have
 604 a calendar window.
 605
 606    The dates used by Emacs for holidays are based on _current
 607 practice_, not historical fact.  Historically, for instance, the start
 608 of daylight savings time and even its existence have varied from year to
 609 year, but present United States law mandates that daylight savings time
 610 begins on the first Sunday in April.  When the daylight savings rules
 611 are set up for the United States, Emacs always uses the present
 612 definition, even though it is wrong for some prior years.
 613
 614 \1f
 615 File: xemacs.info,  Node: Sunrise/Sunset,  Next: Lunar Phases,  Prev: Holidays,  Up: Calendar/Diary
 616
 617 Times of Sunrise and Sunset
 618 ---------------------------
 619
 620    Special calendar commands can tell you, to within a minute or two,
 621 the times of sunrise and sunset for any date.
 622
 623 `S'
 624      Display times of sunrise and sunset for the selected date
 625      (`calendar-sunrise-sunset').
 626
 627 `Button2 Sunrise/Sunset'
 628      Display times of sunrise and sunset for the date you click on.
 629
 630 `M-x sunrise-sunset'
 631      Display times of sunrise and sunset for today's date.
 632
 633 `C-u M-x sunrise-sunset'
 634      Display times of sunrise and sunset for a specified date.
 635
 636    Within the calendar, to display the _local times_ of sunrise and
 637 sunset in the echo area, move point to the date you want, and type `S'.
 638 Alternatively, click `Button2' on the date, then choose
 639 `Sunrise/Sunset' from the menu that appears.  The command `M-x
 640 sunrise-sunset' is available outside the calendar to display this
 641 information for today's date or a specified date.  To specify a date
 642 other than today, use `C-u M-x sunrise-sunset', which prompts for the
 643 year, month, and day.
 644
 645    You can display the times of sunrise and sunset for any location and
 646 any date with `C-u C-u M-x sunrise-sunset'.  This asks you for a
 647 longitude, latitude, number of minutes difference from Coordinated
 648 Universal Time, and date, and then tells you the times of sunrise and
 649 sunset for that location on that date.
 650
 651    Because the times of sunrise and sunset depend on the location on
 652 earth, you need to tell Emacs your latitude, longitude, and location
 653 name before using these commands.  Here is an example of what to set:
 654
 655      (setq calendar-latitude 40.1)
 656      (setq calendar-longitude -88.2)
 657      (setq calendar-location-name "Urbana, IL")
 658
 659 Use one decimal place in the values of `calendar-latitude' and
 660 `calendar-longitude'.
 661
 662    Your time zone also affects the local time of sunrise and sunset.
 663 Emacs usually gets time zone information from the operating system, but
 664 if these values are not what you want (or if the operating system does
 665 not supply them), you must set them yourself.  Here is an example:
 666
 667      (setq calendar-time-zone -360)
 668      (setq calendar-standard-time-zone-name "CST")
 669      (setq calendar-daylight-time-zone-name "CDT")
 670
 671 The value of `calendar-time-zone' is the number of minutes difference
 672 between your local standard time and Coordinated Universal Time
 673 (Greenwich time).  The values of `calendar-standard-time-zone-name' and
 674 `calendar-daylight-time-zone-name' are the abbreviations used in your
 675 time zone.  Emacs displays the times of sunrise and sunset _corrected
 676 for daylight savings time_.  *Note Daylight Savings::, for how daylight
 677 savings time is determined.
 678
 679    As a user, you might find it convenient to set the calendar location
 680 variables for your usual physical location in your init file.  And when
 681 you install Emacs on a machine, you can create a `default.el' file
 682 which sets them properly for the typical location of most users of that
 683 machine.  *Note Init File::.
 684
 685 \1f
 686 File: xemacs.info,  Node: Lunar Phases,  Next: Other Calendars,  Prev: Sunrise/Sunset,  Up: Calendar/Diary
 687
 688 Phases of the Moon
 689 ------------------
 690
 691    These calendar commands display the dates and times of the phases of
 692 the moon (new moon, first quarter, full moon, last quarter).  This
 693 feature is useful for debugging problems that "depend on the phase of
 694 the moon."
 695
 696 `M'
 697      Display the dates and times for all the quarters of the moon for
 698      the three-month period shown (`calendar-phases-of-moon').
 699
 700 `M-x phases-of-moon'
 701      Display dates and times of the quarters of the moon for three
 702      months around today's date.
 703
 704    Within the calendar, use the `M' command to display a separate
 705 buffer of the phases of the moon for the current three-month range.  The
 706 dates and times listed are accurate to within a few minutes.
 707
 708    Outside the calendar, use the command `M-x phases-of-moon' to
 709 display the list of the phases of the moon for the current month and the
 710 preceding and succeeding months.  For information about a different
 711 month, use `C-u M-x phases-of-moon', which prompts for the month and
 712 year.
 713
 714    The dates and times given for the phases of the moon are given in
 715 local time (corrected for daylight savings, when appropriate); but if
 716 the variable `calendar-time-zone' is void, Coordinated Universal Time
 717 (the Greenwich time zone) is used.  *Note Daylight Savings::.
 718
 719 \1f
 720 File: xemacs.info,  Node: Other Calendars,  Next: Calendar Systems,  Prev: Lunar Phases,  Up: Calendar/Diary
 721
 722 Conversion To and From Other Calendars
 723 --------------------------------------
 724
 725    The Emacs calendar displayed is _always_ the Gregorian calendar,
 726 sometimes called the "new style" calendar, which is used in most of the
 727 world today.  However, this calendar did not exist before the sixteenth
 728 century and was not widely used before the eighteenth century; it did
 729 not fully displace the Julian calendar and gain universal acceptance
 730 until the early twentieth century.  The Emacs calendar can display any
 731 month since January, year 1 of the current era, but the calendar
 732 displayed is the Gregorian, even for a date at which the Gregorian
 733 calendar did not exist.
 734
 735    While Emacs cannot display other calendars, it can convert dates to
 736 and from several other calendars.
 737
 738 * Menu:
 739
 740 * Calendar Systems::      The calendars Emacs understands
 741                             (aside from Gregorian).
 742 * To Other Calendar::     Converting the selected date to various calendars.
 743 * From Other Calendar::   Moving to a date specified in another calendar.
 744 * Mayan Calendar::        Moving to a date specified in a Mayan calendar.
 745
 746    If you are interested in these calendars, you can convert dates one
 747 at a time.  Put point on the desired date of the Gregorian calendar and
 748 press the appropriate keys.  The `p' is a mnemonic for "print" since
 749 Emacs "prints' the equivalent date in the echo area.
 750
 751 \1f
 752 File: xemacs.info,  Node: Calendar Systems,  Next: To Other Calendar,  Prev: Other Calendars,  Up: Other Calendars
 753
 754 Supported Calendar Systems
 755 ==========================
 756
 757    The ISO commercial calendar is used largely in Europe.
 758
 759    The Julian calendar, named after Julius Caesar, was the one used in
 760 Europe throughout medieval times, and in many countries up until the
 761 nineteenth century.
 762
 763    Astronomers use a simple counting of days elapsed since noon, Monday,
 764 January 1, 4713 B.C. on the Julian calendar.  The number of days elapsed
 765 is called the _Julian day number_ or the _Astronomical day number_.
 766
 767    The Hebrew calendar is used by tradition in the Jewish religion.  The
 768 Emacs calendar program uses the Hebrew calendar to determine the dates
 769 of Jewish holidays.  Hebrew calendar dates begin and end at sunset.
 770
 771    The Islamic calendar is used in many predominantly Islamic countries.
 772 Emacs uses it to determine the dates of Islamic holidays.  There is no
 773 universal agreement in the Islamic world about the calendar; Emacs uses
 774 a widely accepted version, but the precise dates of Islamic holidays
 775 often depend on proclamation by religious authorities, not on
 776 calculations.  As a consequence, the actual dates of observance can vary
 777 slightly from the dates computed by Emacs.  Islamic calendar dates begin
 778 and end at sunset.
 779
 780    The French Revolutionary calendar was created by the Jacobins after
 781 the 1789 revolution, to represent a more secular and nature-based view
 782 of the annual cycle, and to install a 10-day week in a rationalization
 783 measure similar to the metric system.  The French government officially
 784 abandoned this calendar at the end of 1805.
 785
 786    The Maya of Central America used three separate, overlapping calendar
 787 systems, the _long count_, the _tzolkin_, and the _haab_.  Emacs knows
 788 about all three of these calendars.  Experts dispute the exact
 789 correlation between the Mayan calendar and our calendar; Emacs uses the
 790 Goodman-Martinez-Thompson correlation in its calculations.
 791
 792    The Copts use a calendar based on the ancient Egyptian solar
 793 calendar.  Their calendar consists of twelve 30-day months followed by
 794 an extra five-day period.  Once every fourth year they add a leap day
 795 to this extra period to make it six days.  The Ethiopic calendar is
 796 identical in structure, but has different year numbers and month names.
 797
 798    The Persians use a solar calendar based on a design of Omar Khayyam.
 799 Their calendar consists of twelve months of which the first six have 31
 800 days, the next five have 30 days, and the last has 29 in ordinary years
 801 and 30 in leap years.  Leap years occur in a complicated pattern every
 802 four or five years.
 803
 804    The Chinese calendar is a complicated system of lunar months arranged
 805 into solar years.  The years go in cycles of sixty, each year containing
 806 either twelve months in an ordinary year or thirteen months in a leap
 807 year; each month has either 29 or 30 days.  Years, ordinary months, and
 808 days are named by combining one of ten "celestial stems" with one of
 809 twelve "terrestrial branches" for a total of sixty names that are
 810 repeated in a cycle of sixty.
 811
 812 \1f
 813 File: xemacs.info,  Node: To Other Calendar,  Next: From Other Calendar,  Prev: Calendar Systems,  Up: Other Calendars
 814
 815 Converting To Other Calendars
 816 =============================
 817
 818    The following commands describe the selected date (the date at point)
 819 in various other calendar systems:
 820
 821 `Button2  Other Calendars'
 822      Display the date that you click on, expressed in various other
 823      calendars.
 824
 825 `p c'
 826      Display ISO commercial calendar equivalent for selected day
 827      (`calendar-print-iso-date').
 828
 829 `p j'
 830      Display Julian date for selected day
 831      (`calendar-print-julian-date').
 832
 833 `p a'
 834      Display astronomical (Julian) day number for selected day
 835      (`calendar-print-astro-day-number').
 836
 837 `p h'
 838      Display Hebrew date for selected day
 839      (`calendar-print-hebrew-date').
 840
 841 `p i'
 842      Display Islamic date for selected day
 843      (`calendar-print-islamic-date').
 844
 845 `p f'
 846      Display French Revolutionary date for selected day
 847      (`calendar-print-french-date').
 848
 849 `p C'
 850      Display Chinese date for selected day
 851      (`calendar-print-chinese-date').
 852
 853 `p k'
 854      Display Coptic date for selected day
 855      (`calendar-print-coptic-date').
 856
 857 `p e'
 858      Display Ethiopic date for selected day
 859      (`calendar-print-ethiopic-date').
 860
 861 `p p'
 862      Display Persian date for selected day
 863      (`calendar-print-persian-date').
 864
 865 `p m'
 866      Display Mayan date for selected day (`calendar-print-mayan-date').
 867
 868    If you are using X, the easiest way to translate a date into other
 869 calendars is to click on it with `Button2', then choose `Other
 870 Calendars' from the menu that appears.  This displays the equivalent
 871 forms of the date in all the calendars Emacs understands, in the form of
 872 a menu.  (Choosing an alternative from this menu doesn't actually do
 873 anything--the menu is used only for display.)
 874
 875    Put point on the desired date of the Gregorian calendar, then type
 876 the appropriate keys.  The `p' is a mnemonic for "print" since Emacs
 877 "prints" the equivalent date in the echo area.
 878
 879 \1f
 880 File: xemacs.info,  Node: From Other Calendar,  Next: Mayan Calendar,  Prev: To Other Calendar,  Up: Other Calendars
 881
 882 Converting From Other Calendars
 883 ===============================
 884
 885    You can use the other supported calendars to specify a date to move
 886 to.  This section describes the commands for doing this using calendars
 887 other than Mayan; for the Mayan calendar, see the following section.
 888
 889 `g c'
 890      Move to a date specified in the ISO commercial calendar
 891      (`calendar-goto-iso-date').
 892
 893 `g j'
 894      Move to a date specified in the Julian calendar
 895      (`calendar-goto-julian-date').
 896
 897 `g a'
 898      Move to a date specified in astronomical (Julian) day number
 899      (`calendar-goto-astro-day-number').
 900
 901 `g h'
 902      Move to a date specified in the Hebrew calendar
 903      (`calendar-goto-hebrew-date').
 904
 905 `g i'
 906      Move to a date specified in the Islamic calendar
 907      (`calendar-goto-islamic-date').
 908
 909 `g f'
 910      Move to a date specified in the French Revolutionary calendar
 911      (`calendar-goto-french-date').
 912
 913 `g C'
 914      Move to a date specified in the Chinese calendar
 915      (`calendar-goto-chinese-date').
 916
 917 `g p'
 918      Move to a date specified in the Persian calendar
 919      (`calendar-goto-persian-date').
 920
 921 `g k'
 922      Move to a date specified in the Coptic calendar
 923      (`calendar-goto-coptic-date').
 924
 925 `g e'
 926      Move to a date specified in the Ethiopic calendar
 927      (`calendar-goto-ethiopic-date').
 928
 929    These commands ask you for a date on the other calendar, move point
 930 to the Gregorian calendar date equivalent to that date, and display the
 931 other calendar's date in the echo area.  Emacs uses strict completion
 932 (*note Completion::) whenever it asks you to type a month name, so you
 933 don't have to worry about the spelling of Hebrew, Islamic, or French
 934 names.
 935
 936    One common question concerning the Hebrew calendar is the computation
 937 of the anniversary of a date of death, called a "yahrzeit."  The Emacs
 938 calendar includes a facility for such calculations.  If you are in the
 939 calendar, the command `M-x list-yahrzeit-dates' asks you for a range of
 940 years and then displays a list of the yahrzeit dates for those years
 941 for the date given by point.  If you are not in the calendar, this
 942 command first asks you for the date of death and the range of years,
 943 and then displays the list of yahrzeit dates.
 944
 945 \1f
 946 File: xemacs.info,  Node: Mayan Calendar,  Next: Diary,  Prev: From Other Calendar,  Up: Other Calendars
 947
 948 Converting from the Mayan Calendar
 949 ----------------------------------
 950
 951    Here are the commands to select dates based on the Mayan calendar:
 952
 953 `g m l'
 954      Move to a date specified by the long count calendar
 955      (`calendar-goto-mayan-long-count-date').
 956
 957 `g m n t'
 958      Move to the next occurrence of a place in the tzolkin calendar
 959      (`calendar-next-tzolkin-date').
 960
 961 `g m p t'
 962      Move to the previous occurrence of a place in the tzolkin calendar
 963      (`calendar-previous-tzolkin-date').
 964
 965 `g m n h'
 966      Move to the next occurrence of a place in the haab calendar
 967      (`calendar-next-haab-date').
 968
 969 `g m p h'
 970      Move to the previous occurrence of a place in the haab calendar
 971      (`calendar-previous-haab-date').
 972
 973 `g m n c'
 974      Move to the next occurrence of a place in the calendar round
 975      (`calendar-next-calendar-round-date').
 976
 977 `g m p c'
 978      Move to the previous occurrence of a place in the calendar round
 979      (`calendar-previous-calendar-round-date').
 980
 981    To understand these commands, you need to understand the Mayan
 982 calendars.  The "long count" is a counting of days with these units:
 983
 984      1 kin = 1 day   1 uinal = 20 kin   1 tun = 18 uinal
 985      1 katun = 20 tun   1 baktun = 20 katun
 986
 987 Thus, the long count date 12.16.11.16.6 means 12 baktun, 16 katun, 11
 988 tun, 16 uinal, and 6 kin.  The Emacs calendar can handle Mayan long
 989 count dates as early as 7.17.18.13.1, but no earlier.  When you use the
 990 `g m l' command, type the Mayan long count date with the baktun, katun,
 991 tun, uinal, and kin separated by periods.
 992
 993    The Mayan tzolkin calendar is a cycle of 260 days formed by a pair of
 994 independent cycles of 13 and 20 days.  Since this cycle repeats
 995 endlessly, Emacs provides commands to move backward and forward to the
 996 previous or next point in the cycle.  Type `g m p t' to go to the
 997 previous tzolkin date; Emacs asks you for a tzolkin date and moves point
 998 to the previous occurrence of that date.  Similarly, type `g m n t' to
 999 go to the next occurrence of a tzolkin date.
1000
1001    The Mayan haab calendar is a cycle of 365 days arranged as 18 months
1002 of 20 days each, followed a 5-day monthless period.  Like the tzolkin
1003 cycle, this cycle repeats endlessly, and there are commands to move
1004 backward and forward to the previous or next point in the cycle.  Type
1005 `g m p h' to go to the previous haab date; Emacs asks you for a haab
1006 date and moves point to the previous occurrence of that date.
1007 Similarly, type `g m n h' to go to the next occurrence of a haab date.
1008
1009    The Maya also used the combination of the tzolkin date and the haab
1010 date.  This combination is a cycle of about 52 years called a _calendar
1011 round_.  If you type `g m p c', Emacs asks you for both a haab and a
1012 tzolkin date and then moves point to the previous occurrence of that
1013 combination.  Use `g m n c' to move point to the next occurrence of a
1014 combination.  These commands signal an error if the haab/tzolkin date
1015 combination you have typed is impossible.
1016
1017    Emacs uses strict completion (*note Completion::) whenever it asks
1018 you to type a Mayan name, so you don't have to worry about spelling.
1019
1020 \1f
1021 File: xemacs.info,  Node: Diary,  Next: Calendar Customization,  Prev: Mayan Calendar,  Up: Calendar/Diary
1022
1023 The Diary
1024 ---------
1025
1026    The Emacs diary keeps track of appointments or other events on a
1027 daily basis, in conjunction with the calendar.  To use the diary
1028 feature, you must first create a "diary file" containing a list of
1029 events and their dates.  Then Emacs can automatically pick out and
1030 display the events for today, for the immediate future, or for any
1031 specified date.
1032
1033    By default, Emacs uses `~/diary' as the diary file.  This is the
1034 same file that the `calendar' utility uses.  A sample `~/diary' file is:
1035
1036      12/22/1988 Twentieth wedding anniversary!!
1037      &1/1. Happy New Year!
1038      10/22 Ruth's birthday.
1039      * 21, *: Payday
1040      Tuesday--weekly meeting with grad students at 10am
1041               Supowit, Shen, Bitner, and Kapoor to attend.
1042      1/13/89 Friday the thirteenth!!
1043      &thu 4pm squash game with Lloyd.
1044      mar 16 Dad's birthday
1045      April 15, 1989 Income tax due.
1046      &* 15 time cards due.
1047
1048 This example uses extra spaces to align the event descriptions of most
1049 of the entries.  Such formatting is purely a matter of taste.
1050
1051    Although you probably will start by creating a diary manually, Emacs
1052 provides a number of commands to let you view, add, and change diary
1053 entries.  You can also share diary entries with other users (*note
1054 Included Diary Files::).
1055
1056 * Menu:
1057
1058 * Diary Commands::         Viewing diary entries and associated calendar dates.
1059 * Format of Diary File::   Entering events in your diary.
1060 * Date Formats::           Various ways you can specify dates.
1061 * Adding to Diary::        Commands to create diary entries.
1062 * Special Diary Entries::  Anniversaries, blocks of dates, cyclic entries, etc.
1063
1064 \1f
1065 File: xemacs.info,  Node: Diary Commands,  Next: Format of Diary File,  Prev: Diary,  Up: Diary
1066
1067 Commands Displaying Diary Entries
1068 ---------------------------------
1069
1070    Once you have created a `~/diary' file, you can use the calendar to
1071 view it.  You can also view today's events outside of Calendar mode.
1072
1073 `d'
1074      Display all diary entries for the selected date
1075      (`view-diary-entries').
1076
1077 `Button2 Diary'
1078      Display all diary entries for the date you click on.
1079
1080 `s'
1081      Display the entire diary file (`show-all-diary-entries').
1082
1083 `m'
1084      Mark all visible dates that have diary entries
1085      (`mark-diary-entries').
1086
1087 `u'
1088      Unmark the calendar window (`calendar-unmark').
1089
1090 `M-x print-diary-entries'
1091      Print hard copy of the diary display as it appears.
1092
1093 `M-x diary'
1094      Display all diary entries for today's date.
1095
1096 `M-x diary-mail-entries'
1097      Mail yourself email reminders about upcoming diary entries.
1098
1099    Displaying the diary entries with `d' shows in a separate window the
1100 diary entries for the selected date in the calendar.  The mode line of
1101 the new window shows the date of the diary entries and any holidays
1102 that fall on that date.  If you specify a numeric argument with `d', it
1103 shows all the diary entries for that many successive days.  Thus, `2 d'
1104 displays all the entries for the selected date and for the following
1105 day.
1106
1107    Another way to display the diary entries for a date is to click
1108 `Button2' on the date, and then choose `Diary' from the menu that
1109 appears.
1110
1111    To get a broader view of which days are mentioned in the diary, use
1112 the `m' command.  This displays the dates that have diary entries in a
1113 different face (or places a `+' after these dates, if display with
1114 multiple faces is not available).  The command applies both to the
1115 currently visible months and to other months that subsequently become
1116 visible by scrolling.  To turn marking off and erase the current marks,
1117 type `u', which also turns off holiday marks (*note Holidays::).
1118
1119    To see the full diary file, rather than just some of the entries, use
1120 the `s' command.
1121
1122    Display of selected diary entries uses the selective display feature
1123 to hide entries that don't apply.
1124
1125    The diary buffer as you see it is an illusion, so simply printing the
1126 buffer does not print what you see on your screen.  There is a special
1127 command to print hard copy of the diary buffer _as it appears_; this
1128 command is `M-x print-diary-entries'.  It sends the data directly to
1129 the printer.  You can customize it like `lpr-region' (*note Hardcopy::).
1130
1131    The command `M-x diary' displays the diary entries for the current
1132 date, independently of the calendar display, and optionally for the next
1133 few days as well; the variable `number-of-diary-entries' specifies how
1134 many days to include (*note Customization::).
1135
1136    If you put `(diary)' in your init file, this automatically displays
1137 a window with the day's diary entries, when you enter Emacs.  *Note
1138 Init File::.  The mode line of the displayed window shows the date and
1139 any holidays that fall on that date.
1140
1141    Many users like to receive notice of events in their diary as email.
1142 To send such mail to yourself, use the command `M-x
1143 diary-mail-entries'.  A prefix argument specifies how many days
1144 (starting with today) to check; otherwise, the variable
1145 `diary-mail-days' says how many days.
1146
1147 \1f
1148 File: xemacs.info,  Node: Format of Diary File,  Next: Date Formats,  Prev: Diary Commands,  Up: Diary
1149
1150 The Diary File
1151 --------------
1152
1153    Your "diary file" is a file that records events associated with
1154 particular dates.  The name of the diary file is specified by the
1155 variable `diary-file'; `~/diary' is the default.  The `calendar'
1156 utility program supports a subset of the format allowed by the Emacs
1157 diary facilities, so you can use that utility to view the diary file,
1158 with reasonable results aside from the entries it cannot understand.
1159
1160    Each entry in the diary file describes one event and consists of one
1161 or more lines.  An entry always begins with a date specification at the
1162 left margin.  The rest of the entry is simply text to describe the
1163 event.  If the entry has more than one line, then the lines after the
1164 first must begin with whitespace to indicate they continue a previous
1165 entry.  Lines that do not begin with valid dates and do not continue a
1166 preceding entry are ignored.
1167
1168    You can inhibit the marking of certain diary entries in the calendar
1169 window; to do this, insert an ampersand (`&') at the beginning of the
1170 entry, before the date.  This has no effect on display of the entry in
1171 the diary window; it affects only marks on dates in the calendar
1172 window.  Nonmarking entries are especially useful for generic entries
1173 that would otherwise mark many different dates.
1174
1175    If the first line of a diary entry consists only of the date or day
1176 name with no following blanks or punctuation, then the diary window
1177 display doesn't include that line; only the continuation lines appear.
1178 For example, this entry:
1179
1180      02/11/1989
1181            Bill B. visits Princeton today
1182            2pm Cognitive Studies Committee meeting
1183            2:30-5:30 Liz at Lawrenceville
1184            4:00pm Dentist appt
1185            7:30pm Dinner at George's
1186            8:00-10:00pm concert
1187
1188 appears in the diary window without the date line at the beginning.
1189 This style of entry looks neater when you display just a single day's
1190 entries, but can cause confusion if you ask for more than one day's
1191 entries.
1192
1193    You can edit the diary entries as they appear in the window, but it
1194 is important to remember that the buffer displayed contains the _entire_
1195 diary file, with portions of it concealed from view.  This means, for
1196 instance, that the `C-f' (`forward-char') command can put point at what
1197 appears to be the end of the line, but what is in reality the middle of
1198 some concealed line.
1199
1200    _Be careful when editing the diary entries!_  Inserting additional
1201 lines or adding/deleting characters in the middle of a visible line
1202 cannot cause problems, but editing at the end of a line may not do what
1203 you expect.  Deleting a line may delete other invisible entries that
1204 follow it.  Before editing the diary, it is best to display the entire
1205 file with `s' (`show-all-diary-entries').
1206
1207 \1f
1208 File: xemacs.info,  Node: Date Formats,  Next: Adding to Diary,  Prev: Format of Diary File,  Up: Diary
1209
1210 Date Formats
1211 ------------
1212
1213    Here are some sample diary entries, illustrating different ways of
1214 formatting a date.  The examples all show dates in American order
1215 (month, day, year), but Calendar mode supports European order (day,
1216 month, year) as an option.
1217
1218      4/20/93  Switch-over to new tabulation system
1219      apr. 25  Start tabulating annual results
1220      4/30  Results for April are due
1221      */25  Monthly cycle finishes
1222      Friday  Don't leave without backing up files
1223
1224    The first entry appears only once, on April 20, 1993.  The second and
1225 third appear every year on the specified dates, and the fourth uses a
1226 wildcard (asterisk) for the month, so it appears on the 25th of every
1227 month.  The final entry appears every week on Friday.
1228
1229    You can use just numbers to express a date, as in `MONTH/DAY' or
1230 `MONTH/DAY/YEAR'.  This must be followed by a nondigit.  In the date
1231 itself, MONTH and DAY are numbers of one or two digits.  The optional
1232 YEAR is also a number, and may be abbreviated to the last two digits;
1233 that is, you can use `11/12/1989' or `11/12/89'.
1234
1235    Dates can also have the form `MONTHNAME DAY' or `MONTHNAME DAY,
1236 YEAR', where the month's name can be spelled in full or abbreviated to
1237 three characters (with or without a period).  Case is not significant.
1238
1239    A date may be "generic"; that is, partially unspecified.  Then the
1240 entry applies to all dates that match the specification.  If the date
1241 does not contain a year, it is generic and applies to any year.
1242 Alternatively, MONTH, DAY, or YEAR can be a `*'; this matches any
1243 month, day, or year, respectively.  Thus, a diary entry `3/*/*' matches
1244 any day in March of any year; so does `march *'.
1245
1246    If you prefer the European style of writing dates--in which the day
1247 comes before the month--type `M-x european-calendar' while in the
1248 calendar, or set the variable `european-calendar-style' to `t' _before_
1249 using any calendar or diary command.  This mode interprets all dates in
1250 the diary in the European manner, and also uses European style for
1251 displaying diary dates.  (Note that there is no comma after the
1252 MONTHNAME in the European style.)  To go back to the (default) American
1253 style of writing dates, type `M-x american-calendar'.
1254
1255    You can use the name of a day of the week as a generic date which
1256 applies to any date falling on that day of the week.  You can abbreviate
1257 the day of the week to three letters (with or without a period) or spell
1258 it in full; case is not significant.
1259