File: appt.el.html
appt.el - visible and/or audible notification of
appointments from diary file.
Thanks to Edward M. Reingold for much help and many suggestions,
And to many others for bug fixes and suggestions.
This functions in this file will alert the user of a pending appointment based on his/her diary file. This package is documented in the Emacs manual.
To activate this package, simply use (appt-activate 1).
A diary-file with appointments of the format described in the
documentation of the function appt-check is required.
Relevant customizable variables are also listed in the
documentation of that function.
Today's appointment list is initialized from the diary when this
package is activated. Additionally, the appointments list is
recreated automatically at 12:01am for those who do not logout
every day or are programming late. It is also updated when the
diary-file (or a file it includes) is saved. Calling
appt-check with an argument (or re-enabling the package) forces a
re-initialization at any time.
In order to add or delete items from today's list, without
changing the diary file, use appt-add and appt-delete.
Brief internal description - Skip this if you are not interested!
The function appt-make-list creates the appointments list which
appt-check reads.
You can change the way the appointment window is created/deleted by
setting the variables appt-disp-window-function and
appt-delete-window-function. For instance, you could be set them
to functions that display appointments in pop-up frames, which are
lowered or iconified after appt-display-interval minutes.
Defined variables (17)
appt-audible | Non-nil means beep to indicate appointment. |
appt-buffer-name | Name of the appointments buffer. |
appt-delete-window-function | Function called to remove appointment window and buffer. |
appt-disp-window-function | Function called to display appointment window. |
appt-display-count | Internal variable used to count number of consecutive reminders. |
appt-display-diary | Non-nil displays the diary when the appointment list is first initialized. |
appt-display-duration | The number of seconds an appointment message is displayed. |
appt-display-format | How appointment reminders should be displayed. |
appt-display-interval | Interval in minutes at which to display appointment reminders. |
appt-display-mode-line | Non-nil means display minutes to appointment and time on the mode line. |
appt-max-time | 11:59pm in minutes - number of minutes in a day minus 1. |
appt-message-warning-time | Default time in minutes before an appointment that the warning begins. |
appt-mode-string | String being displayed in the mode line saying you have an appointment. |
appt-prev-comp-time | Time of day (mins since midnight) at which we last checked appointments. |
appt-time-msg-list | The list of appointments for today. |
appt-timer | Timer used for diary appointment notifications (‘appt-check’). |
appt-warning-time-regexp | Regexp matching a string giving the warning time for an appointment. |
Defined functions (13)
appt-activate | (&optional ARG) |
appt-add | (TIME MSG &optional WARNTIME) |
appt-check | (&optional FORCE) |
appt-convert-time | (TIME2CONV) |
appt-delete | () |
appt-delete-window | () |
appt-disp-window | (MIN-TO-APP NEW-TIME APPT-MSG) |
appt-display-message | (STRING MINS) |
appt-make-list | () |
appt-mode-line | (MIN-TO-APP &optional ABBREV) |
appt-select-lowest-window | () |
appt-sort-list | (APPT-LIST) |
appt-update-list | () |
Defined faces (1)
appt-notification | Face for appointment notification on the modeline. Shown when ‘appt-display-mode-line’ is non-nil. |