summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2004-10-05 22:31:35 +0000
committerGlenn Morris <rgm@gnu.org>2004-10-05 22:31:35 +0000
commit47daea4c260bad3f1700d9ed4d48d95a8e4a7720 (patch)
tree87dc125ac6ebfbe729508ee7f79f6e951b75beb8 /man
parent707c20a84afc0f33c7f39b24148556cc9e2a74a5 (diff)
downloademacs-47daea4c260bad3f1700d9ed4d48d95a8e4a7720.tar.gz
From Ulf Jasper <ulf.jasper@web.de>:
(iCalendar): New section for new package.
Diffstat (limited to 'man')
-rw-r--r--man/calendar.texi52
1 files changed, 52 insertions, 0 deletions
diff --git a/man/calendar.texi b/man/calendar.texi
index a4eca0513ff..f85527ad0ea 100644
--- a/man/calendar.texi
+++ b/man/calendar.texi
@@ -37,6 +37,7 @@ information about the calendar and diary.
* Other Calendars:: Converting dates to other calendar systems.
* Diary:: Displaying events from your diary.
* Appointments:: Reminders when it's time to do something.
+* iCalendar:: Converting diary events to/from iCalendar format.
* Daylight Savings:: How to specify when daylight savings time is active.
* Time Intervals:: Keeping track of time intervals.
@end menu
@@ -1383,6 +1384,57 @@ clock. The command @kbd{M-x appt-add} adds entries to the appointment
list without affecting your diary file. You delete entries from the
appointment list with @kbd{M-x appt-delete}.
+@node iCalendar
+@section iCalendar
+@cindex iCalendar support
+
+ The icalendar package aims at providing an implementation of the
+iCalendar standard, as defined in ``RFC 2445 -- Internet Calendaring and
+Scheduling Core Object Specification (iCalendar)''. It provides a means
+for importing [iv]Calendar data into Emacs diary files and vice versa.
+
+ Importing should work correctly for ``ordinary'', i.e. non-recurring,
+events. Recurring events may not be imported correctly, if they are
+imported at all. Exporting of diary files into iCalendar files should
+work correctly for most diary entries. Please note that
+@file{icalendar.el} is work in progress, so usage may evolve in future.
+
+@subsection Usage
+
+ To activate the package, use @code{(require 'icalendar)}.
+
+@findex icalendar-extract-ical-from-buffer
+ The command @code{icalendar-extract-ical-from-buffer} extracts
+iCalendar data from the current buffer and adds it to your (default)
+diary file. It can be used interactively, or for automatic extraction
+of iCalendar data; for example with the VM mail reader one could use:
+
+@example
+(add-hook 'vm-select-new-message-hook 'icalendar-extract-ical-from-buffer)
+@end example
+
+@findex icalendar-import-file
+ The function @code{icalendar-import-file} can be used
+non-interactively to import an iCalendar file. @strong{Caution:} the
+contents of the target diary file are @emph{deleted} by default! It is
+highly recommended to use a dedicated diary file for importing. For
+example:
+
+@example
+(icalendar-import-file "/here/is/calendar.ics" "/there/goes/ical-diary")
+@end example
+
+@noindent
+The import file can be added to the diary using an @code{#include}
+directive. @xref{Fancy Diary Display,,, elisp, The Emacs Lisp Reference
+Manual}.
+
+@findex icalendar-convert-diary-to-ical
+ Use @code{icalendar-convert-diary-to-ical} to interactively export an
+Emacs diary file to iCalendar format. @strong{Caution:} the contents of
+the target file are @emph{deleted} by default!
+
+
@node Daylight Savings
@section Daylight Savings Time
@cindex daylight savings time