summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2015-06-15 23:49:17 -0700
committerGlenn Morris <rgm@gnu.org>2015-06-15 23:49:17 -0700
commitbb53338aaf81bf9f41c4d80d265ddcbd4529b5de (patch)
treef00ade07d3f7854d04b9dfc2d4d696ece7e02d80
parent7ca145d3f991db69d31177f6b0ff51dadef13bf1 (diff)
* doc/emacs/calendar.texi (Specified Dates, Special Diary Entries):
Update date of examples. (Diary, Format of Diary File): Move example from former to latter. Reduce duplication.
-rw-r--r--doc/emacs/calendar.texi71
1 files changed, 36 insertions, 35 deletions
diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi
index 93671364a8..92f5c91941 100644
--- a/doc/emacs/calendar.texi
+++ b/doc/emacs/calendar.texi
@@ -206,7 +206,7 @@ Move point to today's date (@code{calendar-goto-today}).
@kbd{g d} (@code{calendar-goto-date}) prompts for a year, a month, and a day
of the month, and then moves to that date. Because the calendar includes all
dates from the beginning of the current era, you must type the year in its
-entirety; that is, type @samp{1990}, not @samp{90}.
+entirety; that is, type @samp{2010}, not @samp{10}.
@kindex g D @r{(Calendar mode)}
@findex calendar-goto-day-of-year
@@ -919,36 +919,11 @@ years, and then displays the list of yahrzeit dates.
The Emacs diary keeps track of appointments or other events on a daily
basis, in conjunction with the calendar. To use the diary feature, you
-must first create a @dfn{diary file} containing a list of events and
+must first create a diary file containing a list of events and
their dates. Then Emacs can automatically pick out and display the
events for today, for the immediate future, or for any specified
date.
- The name of the diary file is specified by the variable
-@code{diary-file}. The default is @file{~/.emacs.d/diary}, though for
-compatibility with older versions Emacs will use @file{~/diary} if it
-exists. Here's an example showing what the file looks like:
-
-@example
-12/22/2012 Twentieth wedding anniversary!!
-&1/1. Happy New Year!
-10/22 Ruth's birthday.
-* 21, *: Payday
-Tuesday--weekly meeting with grad students at 10am
- Supowit, Shen, Bitner, and Kapoor to attend.
-1/13/89 Friday the thirteenth!!
-&thu 4pm squash game with Lloyd.
-mar 16 Dad's birthday
-April 15, 2013 Income tax due.
-&* 15 time cards due.
-@end example
-
-@noindent
-This format is essentially the same as the one used by the separate
-@command{calendar} utility that is present on some Unix systems. This
-example uses extra spaces to align the event descriptions of most of
-the entries. Such formatting is purely a matter of taste.
-
Although you probably will start by creating a diary manually, Emacs
provides a number of commands to let you view, add, and change diary
entries.
@@ -1069,10 +1044,18 @@ diary-mail-entries}. A prefix argument specifies how many days
@vindex diary-file
Your @dfn{diary file} is a file that records events associated with
particular dates. The name of the diary file is specified by the
-variable @code{diary-file}. The @code{calendar} utility program
-supports a subset of the format allowed by the Emacs diary facilities,
-so you can use that utility to view the diary file, with reasonable
-results aside from the entries it cannot understand.
+variable @code{diary-file}. The default is @file{~/.emacs.d/diary},
+though for compatibility with older versions Emacs will use
+@file{~/diary} if it exists.
+@ignore
+@c I don't think this is relevant any more. The utility doesn't seem
+@c to be part of the default install on GNU/Linux machines these days.
+@c When I tried it with my basic diary file, it just died with an error.
+The @code{calendar} utility program supports a subset of the format
+allowed by the Emacs diary facilities, so you can use that utility to
+view the diary file, with reasonable results aside from the entries it
+cannot understand.
+@end ignore
Each entry in the diary file describes one event and consists of one
or more lines. An entry always begins with a date specification at the
@@ -1080,7 +1063,25 @@ left margin. The rest of the entry is simply text to describe the
event. If the entry has more than one line, then the lines after the
first must begin with whitespace to indicate they continue a previous
entry. Lines that do not begin with valid dates and do not continue a
-preceding entry are ignored.
+preceding entry are ignored. Here's an example:
+
+@example
+12/22/2015 Twentieth wedding anniversary!
+&1/1. Happy New Year!
+10/22 Ruth's birthday.
+* 21, *: Payday
+Tuesday--weekly meeting with grad students at 10am
+ Supowit, Shen, Bitner, and Kapoor to attend.
+1/13/89 Friday the thirteenth!!
+&thu 4pm squash game with Lloyd.
+mar 16 Dad's birthday
+April 15, 2016 Income tax due.
+&* 15 time cards due.
+@end example
+
+@noindent
+This example uses extra spaces to align the event descriptions of most
+of the entries. Such formatting is purely a matter of taste.
You can also use a format where the first line of a diary entry
consists only of the date or day name (with no following blanks or
@@ -1271,12 +1272,12 @@ entry. The entry looks like this:
@findex diary-anniversary
@example
-%%(diary-anniversary 10 31 1948) Arthur's birthday
+%%(diary-anniversary 10 31 1988) Arthur's birthday
@end example
@noindent
-This entry applies to October 31 in any year after 1948; @samp{10 31
-1948} specifies the date. (If you are using the European or ISO
+This entry applies to October 31 in any year after 1988; @samp{10 31
+1988} specifies the date. (If you are using the European or ISO
calendar style, the input order of month, day and year is different.)
The reason this expression requires a beginning year is that advanced
diary functions can use it to calculate the number of elapsed years.